调用ListSchedules获取定时调度列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListSchedules

系统规定参数。取值：ListSchedules。

RequestId String 否 testRequestId

请求ID。如果您指定了该值，系统将使用该值作为本次请求的ID；如果您不指定，系统将随机生成。
FlowName String 是 testFlowName

定时调度绑定的流程名称。该名称在同一地域内唯一，创建后不可修改。取值说明如下：

  • 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。
  • 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。
  • 区分大小写。
  • 长度为1~128个字符。
NextToken String 否 testNextToken

首次查询非必填，NextToken是以FlowName作为下次查询的Token，无下一页数据时，该字段不返回。

Limit Integer 否 1

查询数量。取值范围[1,1000]。

返回数据

名称 类型 示例值 描述
NextToken String testNextToken

下一次查询的开始Token。
RequestId String testRequestId

请求ID。
Schedules Array of Schedules

定时调度信息。
Description String test description

定时调度的描述。
ScheduleId String testScheduleId

定时调度的ID。
Payload String {"key": "value"}

定时调度的触发消息。
ScheduleName String testScheduleName

定时调度的名称。
CreatedTime String 2020-01-01T01:01:01.001Z

定时调度的创建时间。
LastModifiedTime String 2020-01-01T01:01:01.001Z

定时调度最近一次的更改时间。
CronExpression String 0 * * * * *

Cron表达式。
Enable Boolean true

是否启用定时调度。取值说明如下：

  • true：启用。
  • false：禁用。

示例

请求示例

http(s)://[Endpoint]/?Action=ListSchedules
&RequestId=testRequestId
&FlowName=testFlowName
&NextToken=testNextToken
&Limit=1
&公共请求参数

正常返回示例

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
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. 服务器内部错误。请稍后重试。
412 PreconditionFailed The resource to be modified has been changed. 资源查看或更新检查失败，该资源可能已被更改。请稍后重试。
404 FlowNotExists Flow %s does not exist. 所请求资源不存在，请确保流程已创建。

访问错误中心查看更多错误码。