调用 CreateSchedule 创建一个定时调度。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateSchedule

系统规定参数。取值:CreateSchedule。

CronExpression String 0 * * * * *

cron 表达式。

FlowName String testFlowName

定时调度绑定的工作流名称。

ScheduleName String testScheduleName

定时调度的名称。

RequestId String testRequestId

请求指定的 RequestID,如果不指定,系统会随机生成。

Description String test description

定时调度的描述。

Payload String {"key": "value"}

定时调度的触发消息,必须为 json 格式。

Enable Boolean true

定时调度是否启用。

返回数据

名称 类型 示例值 描述
CreatedTime String 2020-01-01T01:01:01.001Z

创建的时间。

CronExpression String 0 * * * * *

cron 表达式。

Description String test description

定时调度的描述。

Enable Boolean true

定时调度是否启用。

LastModifiedTime String 2020-01-01T01:01:01.001Z

最后一次更新的时间。

Payload String {"key": "value"}

定时调度的触发消息。

RequestId String testRequestId

响应的 RequestId。

ScheduleId String testScheduleId

定时调度的 Id。

ScheduleName String testScheduleName

定时调度的名称。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateSchedule
&CronExpression=0 * * * * *
&FlowName=testFlowName
&ScheduleName=testScheduleName
&<公共请求参数>

正常返回示例

XML 格式

<CreateScheduleResponse>
    <Description>Response in XML format is not supported.</Description>
</CreateScheduleResponse>

JSON 格式

{
  "Description":"test description",
  "CreatedTime":"2020-01-01T01:01:01.001Z",
  "RequestId":"testRequestId",
  "LastModifiedTime":"2020-01-01T01:01:01.001Z",
  "Enable":"true",
  "Payload":"{\"key\": \"value\"}",
  "CronExpression":"0 * * * * *",
  "ScheduleId":"testScheduleId",
  "ScheduleName":"testScheduleName"
}

错误码

HttpCode 错误码 错误信息 描述
403 AccessDenied The resources doesn't belong to you. 请求鉴权未通过,具体内容请参考实际错误信息
400 APIVersionNotSupported The requested API version '%s' is not supported yet. Please check. 所请求接口版本不正确。请参考api简介
409 ConcurrentUpdateError Update conflict, please retry. 所请求资源存在并发写操作。请等待一段时间后再次操作
404 FlowNotExists Flow %s does not exist. 所请求资源不存在,请确保流程已创建。
500 InternalServerError An internal error has occurred. Please retry. 服务器内部错误。请稍后重试
400 InvalidArgument Parameter error. 请求参数错误。具体内容请参考实际错误信息
400 MissingRequiredHeader The HTTP header '%s' must be specified. 请求所需参数缺失。具体内容请参考实际错误信息。
400 MissingRequiredParams The HTTP query '%s' must be specified. 请求所需参数缺失。具体内容请参考实际错误信息。
409 ScheduleAlreadyExists The schedule %s already exists in flow %s. 定时调度已存在。

访问错误中心查看更多错误码。