文档首页/ AI开发平台ModelArts/ API参考/ Workflow工作流管理/ 更新工作流定时调度信息
更新时间：2024-10-23 GMT+08:00
查看PDF
分享

更新工作流定时调度信息

功能介绍

更新WorkflowSchedule信息。

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v2/{project_id}/workflows/{workflow_id}/schedules/{schedule_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户项目ID。获取方法请参见获取项目ID和名称。

workflow_id

是

String

工作流的ID。

schedule_id

是

String

工作流调度信息ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

content

否

Map<String,Object>

内容。

enable

否

Boolean

使能标志。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

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

创建时间。
表4 WorkflowSchedulePolicies

参数

参数类型

描述

on_failure

String

定时调度策略中的标记，失败时触发。

on_running

String

定时调度策略中的标记，running时触发。

请求示例

更新调度信息

PUT https://{endpoint}/v2/{project_id}/workflows/{workflow_id}/schedules/fa4ac58e-088b-4fd7-ae8c-b36fee50f884

{
  "content" : {
    "cron" : "0 0 0 * * Thu,Tue",
    "method" : "fixed"
  },
  "enable" : true
}

响应示例

状态码： 200

返回调度信息。

{
  "created_at" : "2022-11-02T09:40:52.714657+08:00",
  "uuid" : "fa4ac58e-088b-4fd7-ae8c-b36fee50f884",
  "type" : "time",
  "content" : {
    "cron" : "0 0 0 * * Thu,Tue",
    "method" : "fixed"
  },
  "action" : "run",
  "policies" : {
    "on_failure" : "retry",
    "on_running" : "cancel"
  },
  "workflow_id" : "f1642618-43eb-4ab1-a0b1-9cc584182c60",
  "user_id" : "75540c679ab44074bc100022d8a4b204",
  "enable" : true
}

状态码

状态码

描述

200

返回调度信息。

错误码

请参见错误码。

相关文档