CreateSchedule - CloudFlow - Alibaba Cloud Documentation Center

Creates a time-based schedule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
FlowName	string	Yes	The name of the workflow that is associated with the time-based schedule.	flow
ScheduleName	string	Yes	The name of the time-based schedule. The name must meet the following conventions: The name can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter or an underscore (_). It is case-sensitive. The name must be 1 to 128 characters in length.	testScheduleName
Description	string	No	The description of the time-based schedule.	test description
Payload	string	No	The trigger message of the time-based schedule. Specify the value in the JSON format.	{"key": "value"}
CronExpression	string	Yes	The CRON expression.	0 * * * * *
Enable	boolean	No	Specifies whether to enable the time-based schedule. Valid values: true false	true

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	testRequestId
Description	string	The description of the time-based schedule.	test description
ScheduleId	string	The ID of the time-based schedule.	testScheduleId
Payload	string	The trigger message of the time-based schedule.	{"key": "value"}
ScheduleName	string	The name of the time-based schedule.	testScheduleName
CreatedTime	string	The time when the time-based schedule was created.	2020-01-01T01:01:01.001Z
LastModifiedTime	string	The time when the time-based schedule was last modified.	2020-01-01T01:01:01.001Z
CronExpression	string	The CRON expression.	0 * * * * *
Enable	boolean	Indicates whether the time-based schedule is enabled.	true

Examples

Sample success responses

JSONformat

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
400	APIVersionNotSupported	The requested API version '%s' is not supported yet. Please check.	-
400	InvalidArgument	Parameter error.	Parameter error.
400	MissingRequiredHeader	The HTTP header '%s' must be specified.	The HTTP header '%s' must be specified.
400	MissingRequiredParams	The HTTP query '%s' must be specified.	The HTTP query '%s' must be specified.
403	AccessDenied	The resources doesn't belong to you.	-
404	FlowNotExists	Flow %s does not exist.	Flow %s does not exist.
409	ConcurrentUpdateError	Update conflict, please retry.	Update conflict, please retry.
409	ScheduleAlreadyExists	The schedule %s already exists in flow %s.	-
500	InternalServerError	An internal error has occurred. Please retry.	An internal error has occurred. Please retry.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-03-21	The Error code has changed. The request parameters of the API has changed	View Change Details