调用CreateSchedule API创建定时调度-云工作流-阿里云-云工作流(CloudFlow)-阿里云帮助中心

创建一个定时调度。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

fnf:CreateSchedule

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
FlowName	string	是	定时调度绑定的工作流名称。	my_flow_name
ScheduleName	string	是	定时调度的名称。取值说明如下：支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。区分大小写。长度为 1~128 个字符。	my_schedule_name
Description	string	否	定时调度的描述。	my test schedule
Payload	string	否	定时调度的触发消息，必须为 JSON 格式。	{"key": "value"}
CronExpression	string	是	Cron 表达式。	0 * * * * *
Enable	boolean	否	是否启用定时调度。取值说明如下： true：启用。 false：禁用。	true

返回参数

名称	类型	描述	示例值
	object	返回数据。
RequestId	string	请求 ID。	testRequestId
Description	string	定时调度的描述。	test description
ScheduleId	string	定时调度的 ID。	testScheduleId
Payload	string	定时调度的触发消息。	{"key": "value"}
ScheduleName	string	定时调度的名称。	testScheduleName
CreatedTime	string	定时调度的创建时间。	2020-01-01T01:01:01.001Z
LastModifiedTime	string	定时调度最近一次的更改时间。	2020-01-01T01:01:01.001Z
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.	请求所需参数缺失。具体内容请参考实际错误信息。
500	InternalServerError	An internal error has occurred. Please retry.	服务器内部错误。请稍后重试。
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.	定时调度已存在。

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

变更历史

更多信息，参考变更详情。