文档首页/云硬盘 EVS/API参考/API/Job任务管理/查询job的状态 - ShowJob
更新时间：2025-11-17 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询job的状态 - ShowJob

功能介绍

查询Job的执行状态。

可用于查询创建云硬盘，扩容云硬盘，删除云硬盘等API的执行状态。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

job_id

是

String

参数解释

job ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

project_id

是

String

参数解释

项目ID。获取方法请参见获取项目ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释

用户Token。

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释

job的状态。

取值范围

  • SUCCESS：成功。

  • RUNNING：运行中。

  • FAIL：失败。

  • INIT：正在初始化。

  • WAITING_EXECUTE：等待执行。

  • LISTENING：job监听中。

entities

JobEntities object

参数解释

job的响应信息。

取值范围

不涉及。

job_id

String

参数解释

job的ID。

取值范围

不涉及。

job_type

String

参数解释

job的类型。

取值范围

  • createVolume：创建单个云硬盘。

  • batchCreateVolume：批量创建云硬盘。

  • deleteVolume：删除单个云硬盘。

  • extendVolume：扩容云硬盘。

  • bulkDeleteVolume：批量删除云硬盘。

  • deleteSingleVolume：批量删除时逐个删除单个云硬盘。

  • retypeVolume：对云硬盘做硬盘类型变更。

begin_time

String

参数解释

开始时间。

取值范围

不涉及。

end_time

String

参数解释

结束时间。

取值范围

不涉及。

error_code

String

参数解释

job执行失败时的错误码。

取值范围

不涉及。

fail_reason

String

参数解释

job执行失败时的错误原因。

取值范围

不涉及。

表4 JobEntities

参数

参数类型

描述

volume_type

String

参数解释

云硬盘的类型。

取值范围

不涉及。

size

Integer

参数解释

云硬盘的容量，单位为GiB。

取值范围

不涉及。

volume_id

String

参数解释

云硬盘的ID。

取值范围

不涉及。

name

String

参数解释

云硬盘的名称。

取值范围

不涉及。

sub_jobs

Array of SubJob objects

参数解释

子Job的信息。当存在子Job信息时，entities中的其他字段将不会返回。

取值范围

不涉及。

表5 SubJob

参数

参数类型

描述

status

String

参数解释

子job的状态。

取值范围

  • SUCCESS：成功。

  • RUNNING：运行中。

  • FAIL：失败。

  • INIT：正在初始化。

entities

SubJobEntities object

参数解释

子job的响应信息。

取值范围

不涉及。

job_id

String

参数解释

子job的ID。

取值范围

不涉及。

job_type

String

参数解释

子job的类型。

取值范围

  • createVolume：创建单个云硬盘。

  • batchCreateVolume：批量创建云硬盘。

  • deleteVolume：删除单个云硬盘。

  • extendVolume：扩容云硬盘。

  • bulkDeleteVolume：批量删除云硬盘。

  • deleteSingleVolume：批量删除时逐个删除单个云硬盘。

  • retypeVolume：对云硬盘做硬盘类型变更。

begin_time

String

参数解释

开始时间。

取值范围

不涉及。

end_time

String

参数解释

结束时间。

取值范围

不涉及。

error_code

String

参数解释

子job执行失败时的错误码。

取值范围

不涉及。

fail_reason

String

参数解释

子job执行失败时的错误原因。

取值范围

不涉及。

表6 SubJobEntities

参数

参数类型

描述

volume_type

String

参数解释

云硬盘的类型。

取值范围

不涉及。

size

Integer

参数解释

云硬盘的容量，单位为GiB。

取值范围

不涉及。

volume_id

String

参数解释

云硬盘的ID。

取值范围

不涉及。

name

String

参数解释

云硬盘的名称。

取值范围

不涉及。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error

Error object

参数解释

出现错误时，返回的错误码。错误码和其对应的含义请参考错误码说明。

取值范围

不涉及。

表8 Error

参数

参数类型

描述

code

String

参数解释

出现错误时，返回的错误码。

取值范围

错误码和其对应的含义请参考错误码说明。

message

String

参数解释

出现错误时，返回的错误消息。

取值范围

不涉及。

请求示例

GET https://{endpoint}/v1/{project_id}/jobs/{job_id}

https://{endpoint}/v1/{project_id}/jobs/{job_id}

响应示例

状态码：200

OK

{
  "status" : "RUNNING",
  "entities" : {
    "volume_id" : "bdf1bb37-f20f-4266-9a04-f43e0a127376"
  },
  "job_id" : "4010a32d535527910153552b492c0002",
  "job_type" : "createVolume",
  "begin_time" : "2016-03-08T07:40:13.219Z",
  "end_time" : ""
}

状态码：400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题： Job任务管理