创建一个定时调度。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| FlowName | string | 是 | 定时调度绑定的工作流名称。 | my_flow_name |
| ScheduleName | string | 是 | 定时调度的名称。取值说明如下：
| my_schedule_name |
| Description | string | 否 | 定时调度的描述。 | my test schedule |
| Payload | string | 否 | 定时调度的触发消息，必须为 JSON 格式。 | {"key": "value"} |
| CronExpression | string | 是 | Cron 表达式。 | 0 * * * * * |
| Enable | boolean | 否 | 是否启用定时调度。取值说明如下：
| 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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | APIVersionNotSupported | The requested API version '%s' is not supported yet. Please check. | - |
| 400 | InvalidArgument | Parameter error. | 请求参数错误。具体内容请参考实际错误信息。 |
| 400 | MissingRequiredHeader | The HTTP header '%s' must be specified. | 请求所需参数缺失。具体内容请参考实际错误信息。 |
| 400 | MissingRequiredParams | The HTTP query '%s' must be specified. | 请求所需参数缺失。具体内容请参考实际错误信息。 |
| 403 | AccessDenied | The resources doesn't belong to you. | - |
| 404 | FlowNotExists | Flow %s does not exist. | 所请求资源不存在，请确保流程已创建。 |
| 409 | ConcurrentUpdateError | Update conflict, please retry. | 所请求资源存在并发写操作。请等待一段时间后再次操作。 |
| 409 | ScheduleAlreadyExists | The schedule %s already exists in flow %s. | 定时调度已存在。 |
| 500 | InternalServerError | An internal error has occurred. Please retry. | 服务器内部错误。请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2024-03-21 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||||||
|