/admin/celery/periodictask/{id}/ - 医洗swagger接口

PeriodicTask celery 任务数据模型
name 名称
task celery任务名称
interval 频率
crontab 任务编排
args 形式参数
kwargs 位置参数
queue 队列名称
exchange 交换
routing_key 路由密钥
expires 过期时间
enabled 是否开启

请求参数

Path 参数

string

必需

Body 参数application/json

Model representing a periodic task.

name

string

Name

必需

Short Description For This Task

>= 1 字符<= 200 字符

task

string

Task Name

必需

The Name of the Celery Task that Should be Run. (Example: "proj.tasks.import_contacts")

>= 1 字符<= 200 字符

args

string

Positional Arguments

可选

JSON encoded positional arguments (Example: ["arg1", "arg2"])

kwargs

string

Keyword Arguments

可选

JSON encoded keyword arguments (Example: {"argument": "value"})

queue

string | null

Queue Override

可选

Queue defined in CELERY_TASK_QUEUES. Leave None for default queuing.

<= 200 字符

exchange

string | null

Exchange

可选

Override Exchange for low-level AMQP routing

<= 200 字符

routing_key

string | null

Routing Key

可选

Override Routing Key for low-level AMQP routing

<= 200 字符

headers

string

AMQP Message Headers

可选

JSON encoded message headers for the AMQP message.

priority

integer | null

Priority

可选

Priority Number between 0 and 255. Supported by: RabbitMQ, Redis (priority reversed, 0 is highest).

>= 0<= 255

expires

string <date-time> | null

Expires Datetime

可选

Datetime after which the schedule will no longer trigger the task to run

expire_seconds

integer | null

Expires timedelta with seconds

可选

Timedelta with seconds which the schedule will no longer trigger the task to run

>= 0<= 4294967295

one_off

boolean

One-off Task

可选

If True, the schedule will only run the task a single time

start_time

string <date-time> | null

Start Datetime

可选

Datetime when the schedule should begin triggering the task to run

enabled

boolean

Enabled

可选

Set to False to disable the schedule

description

string

Description

可选

Detailed description about the details of this Periodic Task

interval

integer | null

Interval Schedule

可选

Interval Schedule to run the task on. Set only one schedule type, leave the others null.

crontab

integer | null

Crontab Schedule

可选

Crontab Schedule to run the task on. Set only one schedule type, leave the others null.

solar

integer | null

Solar Schedule

可选

Solar Schedule to run the task on. Set only one schedule type, leave the others null.

clocked

integer | null

Clocked Schedule

可选

Clocked Schedule to run the task on. Set only one schedule type, leave the others null.

示例

{
    "name": "string",
    "task": "string",
    "args": "string",
    "kwargs": "string",
    "queue": "string",
    "exchange": "string",
    "routing_key": "string",
    "headers": "string",
    "priority": 0,
    "expires": "2019-08-24T14:15:22Z",
    "expire_seconds": 0,
    "one_off": true,
    "start_time": "2019-08-24T14:15:22Z",
    "enabled": true,
    "description": "string",
    "interval": 0,
    "crontab": 0,
    "solar": 0,
    "clocked": 0
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

Model representing a periodic task.

integer

只读可选

create_datetime

string <date-time>

Create datetime

只读可选

update_datetime

string <date-time>

Update datetime

只读可选

creator_name

string

Creator name

只读可选

interval_list

string

Interval list

只读可选

crontab_list

string

Crontab list

只读可选

name

string

Name

必需

Short Description For This Task

>= 1 字符<= 200 字符

task

string

Task Name

必需

The Name of the Celery Task that Should be Run. (Example: "proj.tasks.import_contacts")

>= 1 字符<= 200 字符

args

string

Positional Arguments

可选

JSON encoded positional arguments (Example: ["arg1", "arg2"])

kwargs

string

Keyword Arguments

可选

JSON encoded keyword arguments (Example: {"argument": "value"})

queue

string | null

Queue Override

可选

Queue defined in CELERY_TASK_QUEUES. Leave None for default queuing.

<= 200 字符

exchange

string | null

Exchange

可选

Override Exchange for low-level AMQP routing

<= 200 字符

routing_key

string | null

Routing Key

可选

Override Routing Key for low-level AMQP routing

<= 200 字符

headers

string

AMQP Message Headers

可选

JSON encoded message headers for the AMQP message.

priority

integer | null

Priority

可选

Priority Number between 0 and 255. Supported by: RabbitMQ, Redis (priority reversed, 0 is highest).

>= 0<= 255

expires

string <date-time> | null

Expires Datetime

可选

Datetime after which the schedule will no longer trigger the task to run

expire_seconds

integer | null

Expires timedelta with seconds

可选

Timedelta with seconds which the schedule will no longer trigger the task to run

>= 0<= 4294967295

one_off

boolean

One-off Task

可选

If True, the schedule will only run the task a single time

start_time

string <date-time> | null

Start Datetime

可选

Datetime when the schedule should begin triggering the task to run

enabled

boolean

Enabled

可选

Set to False to disable the schedule

last_run_at

string <date-time>

Last Run Datetime

只读可选

Datetime that the schedule last triggered the task to run. Reset to None if enabled is set to False.

total_run_count

integer

Total Run Count

只读可选

Running count of how many times the schedule has triggered the task

date_changed

string <date-time>

Last Modified

只读可选

Datetime that this PeriodicTask was last modified

description

string

Description

可选

Detailed description about the details of this Periodic Task

interval

integer | null

Interval Schedule

可选

Interval Schedule to run the task on. Set only one schedule type, leave the others null.

crontab

integer | null

Crontab Schedule

可选

Crontab Schedule to run the task on. Set only one schedule type, leave the others null.

solar

integer | null

Solar Schedule

可选

Solar Schedule to run the task on. Set only one schedule type, leave the others null.

clocked

integer | null

Clocked Schedule

可选

Clocked Schedule to run the task on. Set only one schedule type, leave the others null.

示例

{
    "id": 0,
    "create_datetime": "2019-08-24T14:15:22Z",
    "update_datetime": "2019-08-24T14:15:22Z",
    "creator_name": "string",
    "interval_list": "string",
    "crontab_list": "string",
    "name": "string",
    "task": "string",
    "args": "string",
    "kwargs": "string",
    "queue": "string",
    "exchange": "string",
    "routing_key": "string",
    "headers": "string",
    "priority": 0,
    "expires": "2019-08-24T14:15:22Z",
    "expire_seconds": 0,
    "one_off": true,
    "start_time": "2019-08-24T14:15:22Z",
    "enabled": true,
    "last_run_at": "2019-08-24T14:15:22Z",
    "total_run_count": 0,
    "date_changed": "2019-08-24T14:15:22Z",
    "description": "string",
    "interval": 0,
    "crontab": 0,
    "solar": 0,
    "clocked": 0
}