功能介紹
查詢Job的執(zhí)行狀態(tài)。 可用于查詢創(chuàng)建 云硬盤 ,擴(kuò)容云硬盤,刪除云硬盤等API的執(zhí)行狀態(tài)。
調(diào)試
您可以在API Explorer中調(diào)試該接口,支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。
URI
GET /v1/{project_id}/jobs/{job_id}
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
job_id |
是 |
String |
job ID。 |
project_id |
是 |
String |
項(xiàng)目ID。獲取方法請(qǐng)參見"獲取項(xiàng)目ID"。 |
請(qǐng)求參數(shù)
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用戶Token。 通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值)。 |
響應(yīng)參數(shù)
狀態(tài)碼: 200
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
status |
String |
job的狀態(tài)。SUC CES S:成功。RUNNING:運(yùn)行中。FAIL:失敗。INIT:正在初始化。 枚舉值:
|
entities |
job的響應(yīng)信息。 |
|
job_id |
String |
job的ID。 |
job_type |
String |
job的類型。createVolume:創(chuàng)建單個(gè)云硬盤。batchCreateVolume:批量創(chuàng)建云硬盤。deleteVolume:刪除單個(gè)云硬盤。extendVolume:擴(kuò)容云硬盤。bulkDeleteVolume:批量刪除云硬盤。deleteSingleVolume:批量刪除時(shí)逐個(gè)刪除單個(gè)云硬盤。retypeVolume:對(duì)云硬盤做硬盤類型變更。 |
begin_time |
String |
開始時(shí)間。 |
end_time |
String |
結(jié)束時(shí)間。 |
error_code |
String |
job執(zhí)行失敗時(shí)的錯(cuò)誤碼。 |
fail_reason |
String |
job執(zhí)行失敗時(shí)的錯(cuò)誤原因。 |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
volume_type |
String |
云硬盤的類型。 |
size |
Integer |
云硬盤的容量,單位為GiB。 |
volume_id |
String |
云硬盤的ID。 |
name |
String |
云硬盤的名稱。 |
sub_jobs |
子Job的信息。當(dāng)存在子Job信息時(shí),entities中的其他字段將不會(huì)返回。 |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
status |
String |
子job的狀態(tài)。SUCCESS:成功。RUNNING:運(yùn)行中。FAIL:失敗。INIT:正在初始化。 枚舉值:
|
entities |
子job的響應(yīng)信息。 |
|
job_id |
String |
子job的ID。 |
job_type |
String |
子job的類型。createVolume:創(chuàng)建單個(gè)云硬盤。batchCreateVolume:批量創(chuàng)建云硬盤。deleteVolume:刪除單個(gè)云硬盤。extendVolume:擴(kuò)容云硬盤。bulkDeleteVolume:批量刪除云硬盤。deleteSingleVolume:批量刪除時(shí)逐個(gè)刪除單個(gè)云硬盤。retypeVolume:對(duì)云硬盤做硬盤類型變更。 |
begin_time |
String |
開始時(shí)間。 |
end_time |
String |
結(jié)束時(shí)間。 |
error_code |
String |
子job執(zhí)行失敗時(shí)的錯(cuò)誤碼。 |
fail_reason |
String |
子job執(zhí)行失敗時(shí)的錯(cuò)誤原因。 |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
volume_type |
String |
云硬盤的類型。 |
size |
Integer |
云硬盤的容量,單位為GiB。 |
volume_id |
String |
云硬盤的ID。 |
name |
String |
云硬盤的名稱。 |
狀態(tài)碼: 400
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
error |
出現(xiàn)錯(cuò)誤時(shí),返回的錯(cuò)誤信息,具體請(qǐng)參見 error參數(shù)說明。 |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
code |
String |
出現(xiàn)錯(cuò)誤時(shí),返回的錯(cuò)誤碼。錯(cuò)誤碼和其對(duì)應(yīng)的含義請(qǐng)參考錯(cuò)誤碼說明。 |
message |
String |
出現(xiàn)錯(cuò)誤時(shí),返回的錯(cuò)誤消息。 |
請(qǐng)求示例
GET https://{endpoint}/v1/{project_id}/jobs/{job_id} https://{endpoint}/v1/{project_id}/jobs/{job_id}
響應(yīng)示例
狀態(tài)碼: 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" : "" }
狀態(tài)碼: 400
Bad Request
{ "error" : { "message" : "XXXX", "code" : "XXX" } }
狀態(tài)碼
狀態(tài)碼 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
錯(cuò)誤碼
請(qǐng)參見錯(cuò)誤碼。