更新时间:2024-02-27 GMT+08:00

查询job的状态

功能介绍

查询Job的执行状态。 可用于查询创建云硬盘,扩容云硬盘,删除云硬盘等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:等待执行。

枚举值:

  • SUCCESS

  • RUNNING

  • FAIL

  • INIT

  • WAITING_EXECUTE

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:正在初始化。

枚举值:

  • 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

错误码

请参见错误码