ListSchedules - 获取定时调度列表（仅适用于旧版工作流）

获取定时调度列表。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
fnf:ListSchedules	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
FlowName	string	是	定时调度绑定的流程名称。该名称在同一地域内唯一，创建后不可修改。取值说明如下：支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。区分大小写。长度为 1~128 个字符。	my_flow_name
NextToken	string	否	首次查询非必填，NextToken 是以 FlowName 作为下次查询的 Token，无下一页数据时，该字段不返回。	testNextToken
Limit	integer	否	查询数量。取值范围[1,1000]。	1

返回参数

名称	类型	描述	示例值
	object	返回数据。
NextToken	string	下一次查询的开始 Token。	testNextToken
RequestId	string	请求 ID。	testRequestId
Schedules	array<object>	定时调度信息。
Schedules	object	定时调度信息。
Description	string	定时调度的描述。	test description
ScheduleId	string	定时调度的 ID。	testScheduleId
Payload	string	定时调度的触发消息。	{"key": "value"}
ScheduleName	string	定时调度的名称。	my_schedule_name
CreatedTime	string	定时调度的创建时间。	2020-01-01T01:01:01.001Z
LastModifiedTime	string	定时调度最近一次的更改时间。	2020-01-01T01:01:01.001Z
CronExpression	string	Cron 表达式。	0 * * * * *
Enable	boolean	是否启用定时调度。取值说明如下： true：启用。 false：禁用。	true

示例

正常返回示例

JSON格式

{
  "NextToken": "testNextToken",
  "RequestId": "testRequestId",
  "Schedules": [
    {
      "Description": "test description",
      "ScheduleId": "testScheduleId",
      "Payload": "{\"key\": \"value\"}",
      "ScheduleName": "my_schedule_name",
      "CreatedTime": "2020-01-01T01:01:01.001Z",
      "LastModifiedTime": "2020-01-01T01:01:01.001Z",
      "CronExpression": "0 * * * * *",
      "Enable": true
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
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.	请求参数错误。具体内容请参考实际错误信息。
400	MissingRequiredHeader	The HTTP header '%s' must be specified.	请求所需参数缺失。具体内容请参考实际错误信息。
400	MissingRequiredParams	The HTTP query '%s' must be specified.	请求所需参数缺失。具体内容请参考实际错误信息。
403	AccessDenied	The resources doesn't belong to you.	-
404	FlowNotExists	Flow %s does not exist.	所请求资源不存在，请确保流程已创建。
412	PreconditionFailed	The resource to be modified has been changed.	资源查看或更新检查失败，该资源可能已被更改。请稍后重试。
500	InternalServerError	An internal error has occurred. Please retry.	服务器内部错误。请稍后重试。

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

变更历史

变更时间	变更内容概要	操作
2024-03-21	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情