Queries time-based schedules in a flow.
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 Resourcesis 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 |
|---|---|---|---|---|
| fnf:ListSchedules | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| FlowName | string | Yes | The name of the flow that is associated with the time-based schedules. The name is unique within the region and cannot be modified after the flow is created. The name must meet the following conventions:
| testFlowName |
| NextToken | string | No | For the first query, you do not need to specify this parameter. The system uses the value of the FlowName parameter as the value of the NextToken parameter. When the query ends, no value is returned for this parameter. | testNextToken |
| Limit | integer | No | The number of schedules that you want to query. Valid values: 1 to 1000. | 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"NextToken": "testNextToken",
"RequestId": "testRequestId",
"Schedules": [
{
"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 | ActionNotSupported | The requested API operation '%s' is incorrect. Please check. | - |
| 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. |
| 412 | PreconditionFailed | The resource to be modified has been changed. | The resource to be modified has been changed. Please try again later. |
| 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 |