创建定时任务 - IDMesh APIs

请求参数

Body 参数application/json

namespace

string

命名空间

必需

定时任务所属空间，也可以用来区分不同空间下的定时任务

name

string

任务名称

必需

descr

string

描述

可选

tags

array[string]

标签

可选

config

object

任务配置

必需

json raw 格式

kind

string

任务类型

必需

manual 手动触发

cron 定时任务

event 事件触发

from

string

生效时间

可选

默认当前时间，输入格式：rfc3339

exec_cmd

string

任务启动命令

可选

package_id

string

安装包id

可选

当 kind 为 manual 或 cron 时必填

injections

array[object (Injection) {3}]

可选

key

string

参数名

必需

alias

string

别名

可选

注入时的别名，为空则为 key

value

string

参数值

必需

cron

object

可选

定时相关配置，当 kind 为 cron 时必填

exec_frequency

string

执行频率

必需

monthly 每月

weekly 每周

daily 每天

every_12_hour 每 12 小时

every_6_hour 每 6 小时

every_3_hour 每 3 小时

every_2_hour 每 2 小时

hourly 每小时

every_30_minute 每 30 分钟

every_15_minute 每 15 分钟

exec_weekday

integer

星期数

可选

从每星期的第几天开始执行，可选值 0-6，其中 0 表示星期天，weekly 时生效

exec_day

integer

天数

可选

从每个月的第几天开始执行，可选值 1-31，monthly 时生效

exec_hour

integer

小时数

可选

从每天的第几小时开始执行，可选值 0-23

exec_minute

integer

分钟数

可选

从每小时的第几分钟开始执行，可选值 0-59

示例

{
    "namespace": "string",
    "name": "string",
    "descr": "string",
    "tags": [
        "string"
    ],
    "config": {},
    "kind": "string",
    "from": "string",
    "exec_cmd": "string",
    "package_id": "string",
    "injections": [
        {
            "key": "string",
            "alias": "string",
            "value": "string"
        }
    ],
    "cron": {
        "exec_frequency": "string",
        "exec_weekday": 0,
        "exec_day": 0,
        "exec_hour": 0,
        "exec_minute": 0
    }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://127.0.0.1/v1/cron-jobs' \
--header 'Content-Type: application/json' \
--data-raw '{
    "namespace": "string",
    "name": "string",
    "descr": "string",
    "tags": [
        "string"
    ],
    "config": {},
    "kind": "string",
    "from": "string",
    "exec_cmd": "string",
    "package_id": "string",
    "injections": [
        {
            "key": "string",
            "alias": "string",
            "value": "string"
        }
    ],
    "cron": {
        "exec_frequency": "string",
        "exec_weekday": 0,
        "exec_day": 0,
        "exec_hour": 0,
        "exec_minute": 0
    }
}'

返回响应

🟢200成功

application/json

Body

id

string

任务id

必需

示例

{
    "id": "string"
}

🟠400参数错误