云服务器内容精选

  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of ScheduleTaskExecuteHistory objects 定时任务执行记录列表,返回列表条目数量上限为分页的最大上限值。 表5 ScheduleTaskExecuteHistory 参数 参数类型 描述 id String 定时任务执行记录主键id。 task_id String 定时任务主键id。 task_type String 定时任务类型: RESTART_SERVER - 定时重启服务器 START_SERVER - 定时开机 STOP_SERVER - 定时关机 REINSTALL_OS - 定时重装操作系统 status String job状态: WAITING - 等待 RUNNING - 运行中 SUC CES S - 完成 FAILED - 失败 scheduled_type String 执行周期: FIXED_TIME - 指定时间 DAY - 按天 WEEK - 按周 MONTH - 按月 total_count Integer 总子任务数。 success_count Integer 成功的子任务数。 failed_count Integer 失败的子任务数。 excuting_count Integer 正在执行的子任务数。 time_zone String 时区。 begin_time String 任务开始时间。 end_time String 任务结束时间。 create_time String 创建时间。 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 响应示例 状态码:200 成功响应。 { "count" : 0, "items" : [ { "id" : "62f48b59-0ebb-4b1e-ad35-f64948a0591b", "task_id" : "62f48b59-0ebb-4b1e-ad35-f64948a0591b", "task_type" : "RESTART_SERVER", "status" : "WAITING", "scheduled_type" : "day", "total_count" : 10, "success_count" : 5, "failed_count" : 4, "excuting_count" : 4, "time_zone" : "Asia/Shanghai", "begin_time" : "2022-03-07T10:40:43.858Z", "end_time" : "2022-03-07T10:40:43.858Z", "create_time" : "2022-03-07T10:40:43.858Z" } ] }
  • URI GET /v1/{project_id}/schedule-task/{task_id}/execute-history 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 task_id 是 String 定时任务唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量,默认值0。 limit 否 Integer 查询的数量,值区间[1-100],默认值10。
  • 请求示例 { "scheduled_type" : "day", "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", "task_name" : "定时开机任务", "task_type" : "RESTART_SERVER", "schedule_task_policy" : { "enforcement_enable" : false }, "description" : "用于开关机。", "is_enable" : true, "target_infos" : [ { "target_type" : "SERVER", "target_id" : [ "3f791197-d166-4c8e-81e4-38c40ffc1989" ], "target_name" : "测试桌面" } ] }
  • 响应参数 状态码:200 表6 响应Body参数 参数 参数类型 描述 id String 定时任务主键id。 task_name String 任务名称。 last_status String job状态: WAITING - 等待 RUNNING - 运行中 SUCCESS - 完成 FAILED - 失败 task_type String 定时任务类型: RESTART_SERVER - 定时重启服务器 START_SERVER - 定时开机 STOP_SERVER - 定时关机 REINSTALL_OS - 定时重装操作系统 task_cron String 定时任务表达式。 next_execution_time String 下一次执行时间。 schedule_task_policy ScheduleTaskPolicy object 定时任务策略。 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 到期时间。 description String 任务描述。 is_enable Boolean 是否是开启状态。 create_time String 创建时间。 update_time String 更新时间。 表7 ScheduleTaskPolicy 参数 参数类型 描述 enforcement_enable Boolean 当存在会话的时候,是否强制执行,强制执行开关。取值为: false:表示关闭。 true:表示开启。 状态码:400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:405 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:503 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 响应示例 状态码:200 成功响应。 { "id" : "62f48b59-0ebb-4b1e-ad35-f64948a0591b", "task_name" : "定时开机任务", "last_status" : "WAITING", "task_type" : "RESTART_SERVER", "task_cron" : "*/10 * * * * ?", "next_execution_time" : "2022-12-23 09:00:00", "schedule_task_policy" : { "enforcement_enable" : false }, "scheduled_type" : "day", "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", "description" : "用于开关机。", "is_enable" : false, "create_time" : "2022-03-07T10:40:43.858Z", "update_time" : "2024-12-25T12:38:27.942Z" }
  • 请求参数 表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 到期时间。 task_name 否 String 任务名称,名称需满足如下规则: 由中文,英文大小写,数字,_-组成,不能有空格 长度范围1~64个字符 task_type 否 String 定时任务类型: RESTART_SERVER - 定时重启服务器 START_SERVER - 定时开机 STOP_SERVER - 定时关机 REINSTALL_OS - 定时重装操作系统 schedule_task_policy 否 ScheduleTaskPolicy object 定时任务策略。 description 否 String 任务描述。 is_enable 否 Boolean 是否启用: 'true': 启用 'false': 禁用 target_infos 否 Array of TargetInfo objects 定时任务对象列表。 表4 ScheduleTaskPolicy 参数 是否必选 参数类型 描述 enforcement_enable 否 Boolean 当存在会话的时候,是否强制执行,强制执行开关。取值为: false:表示关闭。 true:表示开启。 表5 TargetInfo 参数 是否必选 参数类型 描述 target_type 是 String 定时任务对象类型: SERVER - 服务器 SERVER_GROUP - 服务器组 target_id 是 String 对象id。
  • 响应示例 状态码:200 查询定时任务列表响应。 { "scheduled_tasks" : [ { "id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx", "task_name" : "测试任务", "task_type" : "START", "scheduled_type" : "FIXED_TIME", "life_cycle_type" : "string", "last_status" : "SUCCESS", "next_execution_time" : "2022-12-23 09:00:00", "enable" : true, "description" : "一个描述。", "priority" : 0, "time_zone" : "string", "wait_time" : 0 } ], "total_count" : 10 }
  • URI GET /v2/{project_id}/scheduled-tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 用于分页查询,查询的起始记录序号,从0开始。 limit 是 Integer 用于分页查询,每页返回的个数,取值范围0~50。 task_name 否 String 任务名称。 task_type 否 String 任务类型。START:开机,STOP:关机,REBOOT:重启,HIBERNATE:休眠,REBUILD:重建系统盘,EXECUTE_SCRIPT:执行脚本,CREATE_SNAPSHOT:创建EVS镜像。 scheduled_type 否 String 执行周期类型。FIXED_TIME:指定时间,DAY:按天,WEEK:按周,MONTH:按月,LIFE_CYCLE:触发式。指定LIFE_CYCLE时,才返回触发式任务。 life_cycle_type 否 String 触发场景类型。POST_CREATE_DESKTOP_SUCCESS:创建桌面成功后,POST_REBUILD_DESKTOP_SUCCESS:重建桌面成功后,POST_REATTACH_DESKTOP_SUCCESS:触发重建的分配用户任务成功后,POST_DESKTOP_DISCONNECTED:桌面断开连接后。 last_status 否 String 最近一次执行状态。SUCCESS:成功,SKIP:跳过,FAIL:失败。
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 scheduled_tasks Array of ScheduledTask objects 定时任务列表。 total_count Integer 总个数。 表5 ScheduledTask 参数 参数类型 描述 id String 任务id。 task_name String 任务名称。 task_type String 任务类型。START:开机,STOP:关机,REBOOT:重启,HIBERNATE:休眠,REBUILD:重建系统盘,EXECUTE_SCRIPT:执行脚本,CREATE_SNAPSHOT:创建快照。 scheduled_type String 执行周期。FIXED_TIME:指定时间,DAY:按天,WEEK:按周,MONTH:按月。 life_cycle_type String 触发场景类型。 last_status String 最近一次执行状态。SUCCESS:成功,SKIP:跳过,FAIL:失败。 next_execution_time String 下一次执行时间。格式为yyyy-MM-dd HH:mm:ss。 enable Boolean 是否启用。 description String 描述。 priority Integer 优先级。触发式任务使用。 time_zone String 时区。 wait_time Integer 触发式任务触发后,等待时长。 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。
  • 克隆定时任务 定时任务创建完成后,支持将定时任务克隆到当前应用中。例如,应用A中存在两个或多个功能类似的定时任务,此时可基于已创建的定时任务克隆出一个新定时任务,基于克隆后的定时任务进行修改,减少重复创建的操作。 参考登录AstroZero新版应用设计器中操作,登录应用设计器。 在左侧导航栏中,选择“流程”。 将鼠标放在定时任务上,单击,选择“克隆”。 设置定时任务的唯一标识,单击“确认”。 克隆成功后,在定时任务目录下,可查看到克隆成功的定时任务。
  • 删除定时任务 应用中的某个定时任务不再使用时,支持将其从应用中删除,避免占用账号的资源配额。 参考登录AstroZero新版应用设计器中操作,登录应用设计器。 在左侧导航栏中,选择“流程”。 在定时任务列表中,单击待删除的定时任务,进入任务详情页面。 在详情页面中,单击“禁用”,禁用该任务。 任务禁用后,将鼠标放在定时任务上,单击,选择“删除”。 在弹出的页面,勾选“同时删除资源中的记录?”,单击“确认”,即可删除定时任务。 删除定时任务时,如果不勾选“同时删除资源中的记录?”,仅会删除该定时任务,使用该定时任务的功能模块不会受到影响可正常使用。