Queries the time-based schedules of a flow.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListSchedules |
The operation that you want to perform. Set the value to ListSchedules. |
FlowName | String | Yes | testFlowName |
The name of the flow bound to the list of time-based schedules you want to query. |
RequestId | String | No | testRequestId |
The ID of the request. If you do not specify this parameter, the system generates a random value. |
NextToken | String | No | testNextToken |
The token for starting the query. |
Limit | Integer | No | 1 |
The maximum number of returned schedules. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
NextToken | String | testNextToken |
The token for starting the next query. |
RequestId | String | testRequestId |
The ID of the request. |
Schedules | Array |
The returned time-based schedules. |
|
CreatedTime | String | 2020-01-01T01:01:01.001Z |
The time when a time-based schedule was created. |
CronExpression | String | 0 * * * * * |
The CRON expression of a time-based schedule. |
Description | String | test description |
The description of a time-based schedule. |
Enable | Boolean | true |
Indicates whether to enable a time-based schedule. |
LastModifiedTime | String | 2020-01-01T01:01:01.001Z |
The time when a time-based schedule was last updated. |
Payload | String | {"key": "value"} |
The trigger message of a time-based schedule. |
ScheduleId | String | testScheduleId |
The ID of a time-based schedule. |
ScheduleName | String | testScheduleName |
The name of a time-based schedule. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=ListSchedules
&FlowName=testFlowName
&<Common request parameters>
Sample success responses
XML
format
<ListSchedulesResponse>
<Description>Response in XML format is not supported. </Description>
</ListSchedulesResponse>
JSON
format
{
"Schedules":[
{
"Description":"test description",
"CreatedTime":"2020-01-01T01:01:01.001Z",
"LastModifiedTime":"2020-01-01T01:01:01.001Z",
"Enable":"true",
"Payload":"{\"key\": \"value\"}",
"CronExpression":"0 * * * * *",
"ScheduleId":"testScheduleId",
"ScheduleName":"testScheduleName"
}
],
"RequestId":"testRequestId",
"NextToken":"testNextToken"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
403 | AccessDenied | The resources doesn't belong to you. | The error message returned because request authentication failed. For more information, see the actual error message. |
400 | ActionNotSupported | The requested API operation '%s' is incorrect. Please check. | The error message returned because the request method is wrong. For more information, see the API documentation and check the spelling. |
400 | APIVersionNotSupported | The requested API version '%s' is not supported yet. Please check. | The error message returned because the requested API version is wrong. For more information, see Make API requests. |
404 | FlowNotExists | Flow %s does not exist. | The error message returned because the requested resource does not exist. Ensure that the flow has been created. |
500 | InternalServerError | An internal error has occurred. Please retry. | The error message returned because an internal server error has occurred. Try again later. |
400 | InvalidArgument | Parameter error. | The error message returned because the request parameters are invalid. For more information, see the actual error message. |
400 | MissingRequiredHeader | The HTTP header '%s' must be specified. | The error message returned because the required request parameters are missing. For more information, see the actual error message. |
400 | MissingRequiredParams | The HTTP query '%s' must be specified. | The error message returned because the required request parameters are missing. For more information, see the actual error message. |
412 | PreconditionFailed | The resource to be modified has been changed. | The error message returned because resource view or check for updates failed, and the resource may be modified. Try again later. |
For a list of error codes, visit the API Error Center.
For a list of error codes, visit the API Error Center.