# 创建定时任务 - CreateScheduledTasks #### 功能介绍 创建定时任务。 注:需通过开通委托功能接口先对云服务进行授权才可以使用该功能 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=CreateScheduledTasks)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | workspace:scheduledTasks:create | Write | scheduledTask \* | - | - | - | | workspace:scheduledTasks:create | Write | desktop | - | - | - | | workspace:scheduledTasks:create | Write | desktopPool | - | - | - | | workspace:scheduledTasks:create | Write | server | - | - | - | | workspace:scheduledTasks:create | Write | serverGroup | - | - | - | #### URI POST /v2/{project_id}/scheduled-tasks 表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 | 时区。 | | task_type | 是 | String | 任务类型，可选值为： - START：开机。 - STOP：关机。 - REBOOT：重启。 - HIBERNATE：休眠。 - REBUILD：重建系统盘。 - EXECUTE_SCRIPT：执行脚本。 - CREATE_SNAPSHOT：创建快照 | | task_name | 是 | String | 任务名称。 | | force_execute | 否 | Boolean | 是否强制执行，true表示强制执行，false表示不强制执行。 | | description | 否 | String | 描述。 | | extra_params | 否 | String | 扩展参数，json格式。 | | apply_objects | 否 | Array of [ApplyObject] objects | 定时任务应用的对象列表。 | | wait_time | 否 | Integer | 触发式任务触发后，等待时长。 | | life_cycle_exec_period | 否 | Integer | 触发式任务执行周期，单位分钟。最小1分钟，最大10080分钟（7天），默认1440分钟（1天）。 | 表3ApplyObject | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | object_id | 否 | String | 对象ID。 | | object_type | 否 | String | 对象类型，可选值为： - DESKTOP：桌面。 - DESKTOP_POOL：桌面池。 - ALL_DESKTOPS: 所有桌面。 - DESKTOP_TAG：桌面标签。 | | object_name | 否 | String | 对象名称。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_id | String | 任务id。 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：500** 表6响应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", "life_cycle_exec_period" : 1440, "time_zone" : "Asia/Shanghai", "task_type" : "START", "task_name" : "测试任务", "force_execute" : false, "description" : "一个描述。", "extra_params" : "{ \"notify_message\": \"测试\" }", "apply_objects" : [ { "object_id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx", "object_type" : "DESKTOP" } ], "wait_time" : 0 } ``` #### 响应示例 **状态码：200** 正常。 ``` { "task_id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 正常。 | | 400 | 由于包含语法错误，当前请求无法被服务器理解。 | | 500 | 服务内部错误，具体返回错误码请参见错误码说明。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。