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

功能介绍

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

调试

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

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v2/{project_id}/scheduled-tasks/future-executions

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
scheduled_type	否	String	执行周期类型，可选值为： FIXED_TIME：指定时间。 DAY：按天。 WEEK：按周。 MONTH：按月。 LIFE_CYCLE：指定场景下触发。
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。
scheduled_date	否	String	周期指定时间时：表示指定的日期，格式为yyyy-MM-dd。
scheduled_time	否	String	指定的执行时间点，格式为HH:mm:ss。
expire_time	否	String	到期时间，格式为yyyy-MM-dd HH:mm:ss。
gray_count	否	Integer	灰度对象数量，优先级高于gray_desktop_ids。只支持脚本执行。
gray_desktop_ids	否	Array of strings	灰度执行的桌面id列表，优先级低于gray_count。只支持脚本执行。
gray_fail_threshold	否	Integer	灰度失败阈值，灰度执行失败次数达到该值时，不执行下一批任务。只支持脚本执行。
life_cycle_type	否	String	触发场景。POST_CREATE_DESKTOP_SUCCESS：创建桌面成功后，POST_REBUILD_DESKTOP_SUCCESS：重建桌面成功后，POST_REATTACH_DESKTOP_SUCCESS：触发重建的分配用户任务成功后，POST_DESKTOP_DISCONNECTED：桌面断开连接后。
time_zone	否	String	时区。

响应参数

状态码：200

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

状态码：400

表4 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

{
  "scheduled_type" : "FIXED_TIME",
  "day_interval" : 1,
  "week_list" : "1,2,7",
  "month_list" : "1,3,12",
  "date_list" : "1,2,28,L",
  "scheduled_date" : "2022-12-23",
  "scheduled_time" : "09:00:00",
  "expire_time" : "2022-12-31 09:00:00",
  "gray_count" : 1000,
  "gray_desktop_ids" : [ "string" ],
  "gray_fail_threshold" : 1000,
  "life_cycle_type" : "string",
  "time_zone" : "Asia/Shanghai"
}

响应示例

状态码：200

正常。

{
  "future_executions" : [ "string" ]
}

状态码

状态码	描述
200	正常。
400	由于包含语法错误，当前请求无法被服务器理解。
500	服务内部错误，具体返回错误码请参见错误码说明。