功能介紹
查詢一個異步請求任務(wù)（Job）的執(zhí)行狀態(tài)。
對于創(chuàng)建 云服務(wù)器 、刪除云服務(wù)器、云服務(wù)器批量操作和網(wǎng)卡操作等異步API，命令下發(fā)后，會返回任務(wù)ID（Job_id），通過Job_id可以查詢本次異步請求任務(wù)的執(zhí)行狀態(tài)。
如何獲取job_id，請參考響應(yīng)（任務(wù)類）。
調(diào)試
您可以在API Explorer中調(diào)試該接口。
URI
GET /v1/{project_id}/jobs/{job_id}
|
參數(shù) |
是否必選 |
描述 |
|---|---|---|
|
project_id |
是 |
項(xiàng)目ID。 獲取方法請參見獲取項(xiàng)目ID。 |
|
job_id |
是 |
異步請求的任務(wù)ID。 |
請求消息
無
響應(yīng)消息
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
status |
String |
Job的狀態(tài)。
|
|
entities |
Object |
Job操作的對象。 根據(jù)不同Job類型，顯示不同的內(nèi)容，云服務(wù)器相關(guān)操作顯示server_id，網(wǎng)卡相關(guān)操作顯示nic_id。有子Job時為子job的詳情。 |
|
job_id |
String |
異步請求的任務(wù)ID。 |
|
job_type |
String |
異步請求的任務(wù)類型。 |
|
begin_time |
String |
開始時間。 |
|
end_time |
String |
結(jié)束時間。 |
|
error_code |
String |
Job執(zhí)行失敗時的錯誤碼。 Job執(zhí)行成功后，該值為null。 |
|
fail_reason |
String |
Job執(zhí)行失敗時的錯誤原因。 Job執(zhí)行成功后，該值為null。 |
|
message |
String |
查詢Job的API請求出現(xiàn)錯誤時，返回的錯誤消息。 |
|
code |
String |
查詢Job的API請求出現(xiàn)錯誤時，返回的錯誤碼。 錯誤碼和其對應(yīng)的含義請參考通用請求返回值。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
sub_jobs_total |
Integer |
子任務(wù)數(shù)量。 |
|
sub_jobs |
Array of objects |
每個子任務(wù)的執(zhí)行信息。 |
請求示例
查詢一個異步請求任務(wù)（Job）的執(zhí)行狀態(tài)。
GET https://{endpoint}/v1/{project_id}/jobs/{job_id}
響應(yīng)示例
{
"status": "SUCCESS",
"entities": {
"sub_jobs_total": 1,
"sub_jobs": [
{
"status": "SUCCESS",
"entities": {
"server_id": "bae51750-0089-41a1-9b18-5c777978ff6d"
},
"job_id": "2c9eb2c5544cbf6101544f0635672b60",
"job_type": "createSingleServer",
"begin_time": "2016-04-25T20:04:47.591Z",
"end_time": "2016-04-25T20:08:21.328Z",
"error_code": null,
"fail_reason": null
}
]
},
"job_id": "2c9eb2c5544cbf6101544f0602af2b4f",
"job_type": "createServer",
"begin_time": "2016-04-25T20:04:34.604Z",
"end_time": "2016-04-25T20:08:41.593Z",
"error_code": null,
"fail_reason": null
}
返回值
請參考通用請求返回值。
錯誤碼
請參考錯誤碼。
