功能介紹
查詢Job的執(zhí)行狀態(tài)。
對(duì)于創(chuàng)建 裸金屬服務(wù)器 、掛卸卷等異步API，命令下發(fā)后，會(huì)返回“job_id”，通過(guò)“job_id”可以查詢?nèi)蝿?wù)的執(zhí)行狀態(tài)。
調(diào)試
您可以在API Explorer中調(diào)試該接口。
URI
GET /v1/{project_id}/jobs/{job_id}
參數(shù)說(shuō)明請(qǐng)參見(jiàn)表1。
|
參數(shù) |
是否必選 |
描述 |
|---|---|---|
|
project_id |
是 |
項(xiàng)目ID。 獲取方式請(qǐng)參見(jiàn)獲取項(xiàng)目ID。 |
|
job_id |
是 |
Job ID。 |
請(qǐng)求參數(shù)
無(wú)
請(qǐng)求示例
GET https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/jobs/2c9eb2c5544cbf6101544f0635672b60 |
響應(yīng)參數(shù)
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
status |
String |
Job的狀態(tài)。
|
|
entities |
Object |
Job操作的對(duì)象。請(qǐng)參見(jiàn)表2。 根據(jù)不同Job類型，顯示不同的內(nèi)容。裸金屬服務(wù)器相關(guān)操作顯示server_id；網(wǎng)卡相關(guān)操作顯示nic_id；有子Job時(shí)為子Job的詳情。 |
|
job_id |
String |
Job ID。 |
|
job_type |
String |
Job的類型，包含以下類型：
|
|
begin_time |
String |
開(kāi)始時(shí)間。 時(shí)間戳格式為ISO 8601，例如：2019-04-25T20:04:47.591Z |
|
end_time |
String |
結(jié)束時(shí)間。 時(shí)間戳格式為ISO 8601，例如：2019-04-26T20:04:47.591Z |
|
error_code |
String |
Job執(zhí)行失敗時(shí)的錯(cuò)誤碼。 |
|
fail_reason |
String |
Job執(zhí)行失敗時(shí)的錯(cuò)誤原因。 |
|
message |
String |
出現(xiàn)錯(cuò)誤時(shí)，返回的錯(cuò)誤消息。 |
|
code |
String |
出現(xiàn)錯(cuò)誤時(shí)，返回的錯(cuò)誤碼。 錯(cuò)誤碼和其對(duì)應(yīng)的含義請(qǐng)參考狀態(tài)碼。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
status |
String |
Job的狀態(tài)。
|
|
entities |
Array of objects |
Job操作的對(duì)象。根據(jù)不同Job類型，顯示不同的內(nèi)容。裸金屬服務(wù)器相關(guān)操作顯示server_id；網(wǎng)卡相關(guān)操作顯示nic_id。 |
|
job_id |
String |
Job ID。 |
|
job_type |
String |
Job的類型，包含以下類型：
|
|
begin_time |
String |
開(kāi)始時(shí)間。 時(shí)間戳格式為ISO 8601，例如：2019-04-25T20:04:47.591Z |
|
end_time |
String |
結(jié)束時(shí)間。 時(shí)間戳格式為ISO 8601，例如：2019-04-26T20:04:47.591Z |
|
error_code |
String |
Job執(zhí)行失敗時(shí)的錯(cuò)誤碼。 |
|
fail_reason |
String |
Job執(zhí)行失敗時(shí)的錯(cuò)誤原因。 |
|
message |
String |
出現(xiàn)錯(cuò)誤時(shí)，返回的錯(cuò)誤消息。 |
|
code |
String |
出現(xiàn)錯(cuò)誤時(shí)，返回的錯(cuò)誤碼。 錯(cuò)誤碼和其對(duì)應(yīng)的含義請(qǐng)參考狀態(tài)碼。 |
響應(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": "baremetalSingleCreate", "begin_time": "2019-04-25T20:04:47.591Z", "end_time": "2019-04-25T20:08:21.328Z", "error_code": null, "fail_reason": null } ] }, "job_id": "2c9eb2c5544cbf6101544f0602af2b4f", "job_type": "baremetalBatchCreate", "begin_time": "2019-04-25T20:04:34.604Z", "end_time": "2019-04-25T20:08:41.593Z", "error_code": null, "fail_reason": null } |
錯(cuò)誤碼
請(qǐng)參考錯(cuò)誤碼。
