CreateSchedule - CloudFlow - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

fnf:CreateSchedule

create

*All Resource

*

None

Request parameters

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

Response elements

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

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.