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

子任务查询

功能介绍

该接口用于查询异步任务执行情况，比如查询创建桌面的执行状态。

调试

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

URI

GET /v2/{project_id}/workspace-sub-jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id。
表2 Query参数

参数

是否必选

参数类型

描述

status

否

String

任务状态

  • SUCCESS：成功。

  • 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开始。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

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

Content-Type

是

String

发送的实体的MIME类型

响应参数

状态码： 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接口进行解密。

请求示例

GET /v2/ac234de25c6741d2b1273da49eea1b9e/workspace-sub-jobs?status=FAILED&status=RUNNING&job_type=createDesktops

null

响应示例

状态码： 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

任务明细响应

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

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

500

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

503

服务不可用。

错误码

请参见错误码。

父主题： 任务