文档首页/ 云桌面 Workspace/ API参考/ 云应用API/ 任务管理/ 子任务查询
更新时间：2024-12-27 GMT+08:00
查看PDF
分享

子任务查询

功能介绍

该接口用于查询异步子任务执行情况,sub_job_ids非空时offset和limit不会生效。

调试

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

URI

GET /v1/{project_id}/app-server-sub-jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目唯一标识。
表2 Query参数

参数

是否必选

参数类型

描述

status

否

String

job详情的状态：

  • WAITING - 等待

  • RUNNING - 运行中

  • SUCCESS - 成功

  • FAILED - 失败

  • ABNORMAL - 异常

  • ROLLBACK - 回滚中

  • ABORTING - 取消

job_type

是

String

job类型

  • CREATE_SERVER - 创建服务器

  • DELETE_SERVER - 删除服务器

  • REJOIN_DOMAIN - 服务器重新加域

  • CHANGE_SERVER_IMAGE - 修改服务器镜像

  • REINSTALL_OS - 服务器重装操作系统

  • MIGRATE_SERVER - 迁移服务器

  • UPDATE_SERVER_TSVI - 更新虚拟IP配置

  • UPGRADE_ACCESS_AGENT - hda升级

  • SCHEDULED_TASK - 定时任务

  • UPDATE_FREEZE_STATUS - 更新服务器冻结状态

offset

否

Integer

查询的偏移量。

limit

否

Integer

查询的数量，值区间[1-100]。

job_id

否

String

任务ID。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

总数。

items

Array of JobDetailInfo objects

任务明细信息列表，返回列表条目数量上限为分页的最大上限值。
表5 JobDetailInfo

参数

参数类型

描述

id

String

子任务ID。

job_type

String

job类型：

  • CREATE_SERVER - 创建服务器

  • DELETE_SERVER - 删除服务器

  • UPDATE_FREEZE_STATUS - 修改服务器冻结状态

  • CREATE_SERVER_IMAGE - 构建镜像

  • REINSTALL_OS - 重装操作系统

  • CHANGE_SERVER_IMAGE - 更换镜像

  • REJOIN_DOMAIN - 重新加域

  • MIGRATE_SERVER - 迁移服务器

  • UPGRADE_ACCESS_AGENT - hda升级

  • UPDATE_SERVER_TSVI - 更新虚拟会话IP

  • SCHEDULED_TASK - 定时任务job

  • COLLECT_HDA_LOG - 收集hda日志

  • COLLECT_APS_LOG - 收集aps日志

  • CREATE_SERVER_SNAPSHOT - 创建服务器快照

  • DELETE_SERVER_SNAPSHOT - 删除服务器快照

  • RESTORE_SERVER_SNAPSHOT - 恢复服务器快照

job_resource_info

JobResourceInfo object

任务结果对应的资源信息，根据任务类型区分：

  • 服务器 - 服务器信息

  • 镜像 - 镜像信息

begin_time

String

任务创建时间。

end_time

String

任务结束时间。

status

String

job详情的状态：

  • WAITING - 等待

  • RUNNING - 运行中

  • SUCCESS - 成功

  • FAILED - 失败

  • ABNORMAL - 异常

  • ROLLBACK - 回滚中

  • ABORTING - 终止中

error_code

String

任务执行失败时的错误码。

error_message

String

任务失败原因。

project_id

String

项目ID。

job_id

String

任务ID。
表6 JobResourceInfo

参数

参数类型

描述

resource_id

String

资源ID。

resource_name

String

产物名称，或者被操作资源名称。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 405

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 503

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

无

响应示例

状态码： 200

成功响应。

{
  "count" : 0,
  "items" : [ {
    "id" : "1",
    "job_type" : "CREATE_SERVER",
    "job_resource_info" : {
      "resource_id" : "a1a1245-xxxx123d-1425af14",
      "resource_name" : "APS-20220902093902-AYOASWQDEJ"
    },
    "begin_time" : "2022-03-07T10:40:43.858Z",
    "end_time" : "2022-03-07T10:40:43.858Z",
    "status" : "WAITING",
    "error_code" : "WKS.00129901",
    "error_message" : "The service is now unavailable to process the request.",
    "project_id" : "325f2346-xxxx123d-1425af14",
    "job_id" : "1"
  } ]
}

状态码

状态码

描述

200

成功响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误，具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码。

父主题： 任务管理

相关文档