未来执行的具体时间列表 - ListFutureExecutions

功能介绍

未来执行的具体时间列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
workspace:scheduledTasks:getFuture
Read
-
-
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
workspace:scheduledTasks:getFuture	Read	-	-	-	-

URI

POST /v1/{project_id}/schedule-task/future-executions

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目唯一标识。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数
参数	是否必选	参数类型	描述
scheduled_type	否	String	执行周期类型，可选值为： FIXED_TIME：指定时间。 DAY：按天。 WEEK：按周。 MONTH：按月。
day_interval	否	Integer	周期按天时：按x天间隔执行。
week_list	否	String	周期按周时：取值1~7，英文逗号分隔，如1,2,7。
month_list	否	String	周期按月时：取值1~12，英文逗号分隔，如1,3,12。
date_list	否	String	周期按月时：取值1~31及L(代表当月最后一天)，英文逗号分隔，如1,2,28,L。
time_zone	否	String	时区。
scheduled_date	否	String	周期指定时间时：表示指定的日期，格式为yyyy-MM-dd。
scheduled_time	否	String	指定的执行时间点，格式为HH:mm:ss。
expire_time	否	String	到期时间。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
future_executions	Array of strings	未来执行的具体时间列表。
time_zone	String	时区。

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：401

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：403

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：404

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：405

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：500

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：503

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

请求示例

{
  "scheduled_type" : "FIXED_TIME",
  "day_interval" : 1,
  "week_list" : "1,2,7",
  "month_list" : "1,3,12",
  "date_list" : "1,2,28,L",
  "time_zone" : "Asia/Shanghai",
  "scheduled_date" : "2022-12-23",
  "scheduled_time" : "09:00:00",
  "expire_time" : "2022-03-07T10:40:43.858Z"
}

响应示例

状态码：200

成功响应。

{
  "future_executions" : [ "string" ],
  "time_zone" : "Asia/Shanghai"
}

状态码

状态码	描述
200	成功响应。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
405	请求中指定的方法不被允许。
500	服务内部错误，具体返回错误码请参见错误码说明。
503	服务不可用。