文档

CreateSchedule - 创建一个定时调度

更新时间:

创建一个定时调度。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RequestIdstring

请求 ID。如果您指定了该值,系统将使用该值作为本次请求的 ID;如果您不指定,系统将随机生成。

testRequestId
FlowNamestring

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

flow
ScheduleNamestring

定时调度的名称。取值说明如下:

  • 支持英文字符(a~z)或(A~Z)、数字(0~9)、下划线(_)和短划线(-)。
  • 首字母必须为英文字母(a~z)、(A~Z)或下划线(_)。
  • 区分大小写。
  • 长度为 1~128 个字符。
testScheduleName
Descriptionstring

定时调度的描述。

test description
Payloadstring

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

{"key": "value"}
CronExpressionstring

Cron 表达式。

0 * * * * *
Enableboolean

是否启用定时调度。取值说明如下:

  • true:启用。
  • false:禁用。
true

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

testRequestId
Descriptionstring

定时调度的描述。

test description
ScheduleIdstring

定时调度的 ID。

testScheduleId
Payloadstring

定时调度的触发消息。

{"key": "value"}
ScheduleNamestring

定时调度的名称。

testScheduleName
CreatedTimestring

定时调度的创建时间。

2020-01-01T01:01:01.001Z
LastModifiedTimestring

定时调度最近一次的更改时间。

2020-01-01T01:01:01.001Z
CronExpressionstring

Cron 表达式。

0 * * * * *
Enableboolean

是否启用定时调度。

true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400APIVersionNotSupportedThe requested API version '%s' is not supported yet. Please check.-
400InvalidArgumentParameter error.请求参数错误。具体内容请参考实际错误信息。
400MissingRequiredHeaderThe HTTP header '%s' must be specified.请求所需参数缺失。具体内容请参考实际错误信息。
400MissingRequiredParamsThe HTTP query '%s' must be specified.请求所需参数缺失。具体内容请参考实际错误信息。
403AccessDeniedThe resources doesn't belong to you.-
404FlowNotExistsFlow %s does not exist.所请求资源不存在,请确保流程已创建。
409ConcurrentUpdateErrorUpdate conflict, please retry.所请求资源存在并发写操作。请等待一段时间后再次操作。
409ScheduleAlreadyExistsThe schedule %s already exists in flow %s.定时调度已存在。
500InternalServerErrorAn internal error has occurred. Please retry.服务器内部错误。请稍后重试。

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

  • 本页导读 (1)
文档反馈