创建工作流定时调度
功能介绍
创建Workflow定时调度。
接口约束
无
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/workflows/{workflow_id}/schedules
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：用户项目ID。获取方法请参见获取项目ID和名称。 约束限制：1 - 64字符，字母、数字和中划线。 取值范围：不涉及。 默认取值：不涉及。 |
|
workflow_id |
是 |
String |
参数解释：工作流的ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
否 |
String |
类型，仅支持time（时间）。 |
|
content |
否 |
Map<String,Object> |
内容。 |
|
action |
否 |
String |
动作，仅支持run。 |
|
workflow_id |
否 |
String |
Workflow工作流ID。 |
|
user_id |
否 |
String |
用户ID。 |
|
enable |
否 |
Boolean |
定时调度信息，使能标记。 |
|
uuid |
否 |
String |
ID标记。 |
|
policies |
否 |
WorkflowSchedulePolicies object |
调度策略。 |
|
created_at |
否 |
String |
创建时间。 |
响应参数
状态码：201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
类型，仅支持time（时间）。 |
|
content |
Map<String,Object> |
内容。 |
|
action |
String |
动作，仅支持run。 |
|
workflow_id |
String |
Workflow工作流ID。 |
|
user_id |
String |
用户ID。 |
|
enable |
Boolean |
定时调度信息，使能标记。 |
|
uuid |
String |
ID标记。 |
|
policies |
WorkflowSchedulePolicies object |
调度策略。 |
|
created_at |
String |
创建时间。 |
请求示例
创建Workflow定时调度。设置类型为“time”，动作为“run”，调度策略on_failure为“retry”、on_running为“cancel”。
POST https://{endpoint}/v2/{project_id}/workflows/{workflow_id}/schedules
{
"type" : "time",
"action" : "run",
"content" : {
"cron" : "0 0 0 * * Thu",
"method" : "fixed"
},
"policies" : {
"on_failure" : "retry",
"on_running" : "cancel"
}
}
响应示例
状态码：201
定时调度信息。
{
"created_at" : "2022-11-02T09:40:52.714656752+08:00",
"uuid" : "fa4ac58e-088b-4fd7-ae8c-b36fee50f884",
"type" : "time",
"content" : {
"cron" : "0 0 0 * * Thu",
"method" : "fixed"
},
"action" : "run",
"policies" : {
"on_failure" : "retry",
"on_running" : "cancel"
},
"workflow_id" : "f1642618-43eb-4ab1-a0b1-9cc584182c60",
"user_id" : "75540c679ab44074bc100022d8a4b204",
"enable" : true
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
定时调度信息。 |
错误码
请参见错误码。
