Creates a time-based schedule.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
fnf:CreateSchedule | create | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|
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:
| 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 |
Response parameters
Examples
Sample success responses
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 | Description |
---|
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 |
---|
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 |