云服务器内容精选

  • 响应示例 状态码:200 任务明细响应。 { "total_count" : 2, "jobs" : [ { "status" : "RUNNING", "entities" : { "user_name" : "user-test-01", "product_id" : "workspace.c2.large.windows", "desktop_id" : "9d30c8ac-77b5-4453-80da-8f027223ee99" }, "job_id" : "0e2dae94-23ff-449a-bb9c-1b808cf2106d", "job_type" : "createDesktops", "begin_time" : "2020-04-10 06:45:14", "end_time" : "2020-04-10 07:06:10", "id" : "e43caef5-e478-4624-9e8c-b0b636331cbc" }, { "status" : "RUNNING", "entities" : { "user_name" : "user-test-01", "product_id" : "workspace.c2.large.windows", "desktop_id" : "14cccba0-12a6-4b66-9fd9-57290328f8da" }, "job_id" : "0e2dae94-23ff-449a-bb9c-1b808cf2106d", "job_type" : "createDesktops", "begin_time" : "2020-04-10 06:45:14", "end_time" : "2020-04-10 07:05:49", "id" : "cf5043e9-dd94-43be-9c07-6dba5d43c4d2" } ] }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 任务列表总数。 jobs Array of JobDetailInfo objects 任务列表。 表5 JobDetailInfo 参数 参数类型 描述 id String 子任务ID。 job_type String 任务类型。 entities JobEntities object 任务。 begin_time String 任务创建时间。 end_time String 任务结束时间。 status String 任务状态。 error_code String 任务执行失败时的错误码。 fail_reason String 任务失败原因。 host String 任务执行的服务器IP。 project_id String 项目ID。 job_id String 任务ID。 process Integer 任务进度。 attach_user String 关联用户。 entity String 操作对象。 ip_address String ip地址。 表6 JobEntities 参数 参数类型 描述 desktop_id String 桌面ID。 product_id String 套餐ID。 user_name String 用户名。 desktop_name String 桌面名称。 ip_address String ip地址。 状态码:400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:405 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。
  • URI GET /v2/{project_id}/workspace-sub-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String 任务状态 SUC CES S:成功。 RUNNING:运行中。 FAILED:失败。 WAITING:等待。 job_id 否 String 任务ID。 job_type 否 String 任务类型 createDesktops:创建桌面任务。 applyWorkspace:开通 云桌面 服务。 cancelWorkspace:注销云桌面服务。 expandVolumes: 扩容磁盘。 addVolumes: 添加磁盘。 desktop_pool_id 否 String 桌面池ID。 limit 否 Integer 用于分页查询,取值范围0~1000,默认1000。 offset 否 Integer 用于分页查询,查询的起始记录序号,从0开始。
  • 响应参数 状态码: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 - 运行中 SUCCESS - 完成 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。
  • 响应参数 状态码:400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:405 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:503 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 响应参数 状态码: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" }
  • 请求示例 { "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" : "测试桌面" } ] }
  • 请求参数 表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。
  • 响应参数 状态码:400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:405 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:503 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 job_ids 否 Array of strings 任务ID列表,只能删除SUCCESS、FAILED两种状态。job_ids和delete_by_status必传一个。 delete_by_status 否 String 通过任务状态删除,只能删除以下的两种状态 SUCCESS:成功。 FAILED:失败。job_ids和delete_by_status必传一个。
  • 响应示例 状态码:200 成功响应。 { "count" : 0, "items" : [ { "id" : "1", "job_type" : "createServer", "begin_time" : "2022-03-07T10:40:43.858Z", "end_time" : "2022-03-07T10:40:43.858Z", "status" : "WAITING", "sub_jobs_total" : 10 } ] }
  • URI GET /v1/{project_id}/image-server-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String job状态: WAITING - 等待 RUNNING - 运行中 SUCCESS - 完成 FAILED - 失败 job_type 是 String job类型: CREATE_SERVER - 创建镜像实例 CREATE_SERVER_IMAGE - 构建镜像 DELETE_SERVER - 删除镜像实例 offset 否 Integer 查询的偏移量,默认值0。 limit 否 Integer 查询的数量,值区间[1-100],默认值10。