華為云計算 云知識 查詢job狀態(tài)ShowJobStatus
查詢job狀態(tài)ShowJobStatus

 

功能介紹

查詢job的執(zhí)行狀態(tài)。 對于創(chuàng)建保護(hù)組、刪除保護(hù)組、創(chuàng)建保護(hù)實例、刪除保護(hù)實例、創(chuàng)建復(fù)制對、刪除復(fù)制對等異步API,命令下發(fā)后,會返回job_id,通過job_id可以查詢?nèi)蝿?wù)的執(zhí)行狀態(tài)。

接口約束

調(diào)試

您可以在API Explorer中調(diào)試該接口。

URI

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

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

job_id

String

job ID

project_id

String

項目ID

請求參數(shù)

表2 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值)

響應(yīng)參數(shù)

狀態(tài)碼: 200

表3 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

status

String

Job的狀態(tài)。 SUC CES S:成功。 RUNNING:運行中。 FAIL:失敗。 INIT:正在初始化。

枚舉值:

  • SUCCESS

  • RUNNING

  • FAIL

  • INIT

entities

JobEntities object

Job操作的對象。

job_id

String

Job ID。

job_type

String

Job的類型。createProtectionGroupNoCG:創(chuàng)建保護(hù)組。deleteProtectionGroupNoCG:刪除保護(hù)組。startProtectionGroupNoCG :保護(hù)組開始保護(hù)。reprotectProtectionGroupNoCG :保護(hù)組重保護(hù)。stopProtectionGroupNoCG :保護(hù)組停止保護(hù)。failoverProtectionGroupNoCG :保護(hù)組故障切換。reverseProtectionGroupNoCG:保護(hù)組切換。createProtectedInstanceNoCG:創(chuàng)建保護(hù)實例。deleteProtectedInstanceNoCG:刪除保護(hù)實例。attachReplicationPairNew:保護(hù)實例掛載復(fù)制對。detachReplicationPairNew:保護(hù)實例卸載復(fù)制對。addNicNew:保護(hù)實例添加網(wǎng)卡。deleteNicNew:保護(hù)實例刪除網(wǎng)卡。resizeProtectedInstanceNew:保護(hù)實例變更規(guī)格。createReplicationPairNoCG:創(chuàng)建復(fù)制對。deleteReplicationPairNoCG:刪除復(fù)制對。expandReplicationPairNew:復(fù)制對擴(kuò)容。createDisasterRecoveryDrill:創(chuàng)建容災(zāi)演練。deleteDisasterRecoveryDrill:刪除容災(zāi)演練。

begin_time

String

開始時間。默認(rèn)格式為:"yyyy-MM-dd'T'HH:mm:ss.SSSZ",例:"2019-04-01T12:00:00.000Z"。

end_time

String

結(jié)束時間。默認(rèn)格式為:"yyyy-MM-dd'T'HH:mm:ss.SSSZ",例:"2019-04-01T12:00:00.000Z"。

error_code

String

Job執(zhí)行失敗時的錯誤碼。

fail_reason

String

Job執(zhí)行失敗時的錯誤原因。

表4 JobEntities

參數(shù)

參數(shù)類型

描述

replication_pair_id

String

復(fù)制對ID

volume_ids

String

組成復(fù)制對的 云硬盤 ID

server_group_id

String

保護(hù)組ID

protected_instance_id

String

保護(hù)實例ID

native_server_id

String

容災(zāi)站點服務(wù)器ID

nic_id

String

網(wǎng)卡ID

sub_jobs

Array of SubJobParams objects

子Job信息

表5 SubJobParams

參數(shù)

參數(shù)類型

描述

status

String

Job的狀態(tài)。 SUCCESS:成功。 RUNNING:運行中。 FAIL:失敗。 INIT:正在初始化。

枚舉值:

  • SUCCESS

  • RUNNING

  • FAIL

  • INIT

entities

SubJobEntities object

Job操作的對象。

job_id

String

Job ID。

job_type

String

Job的類型。createProtectionGroupNoCG:創(chuàng)建保護(hù)組。deleteProtectionGroupNoCG:刪除保護(hù)組。startProtectionGroupNoCG :保護(hù)組開始保護(hù)。reprotectProtectionGroupNoCG :保護(hù)組重保護(hù)。stopProtectionGroupNoCG :保護(hù)組停止保護(hù)。failoverProtectionGroupNoCG :保護(hù)組故障切換。reverseProtectionGroupNoCG:保護(hù)組切換。createProtectedInstanceNoCG:創(chuàng)建保護(hù)實例。deleteProtectedInstanceNoCG:刪除保護(hù)實例。attachReplicationPairNew:保護(hù)實例掛載復(fù)制對。detachReplicationPairNew:保護(hù)實例卸載復(fù)制對。addNicNew:保護(hù)實例添加網(wǎng)卡。deleteNicNew:保護(hù)實例刪除網(wǎng)卡。resizeProtectedInstanceNew:保護(hù)實例變更規(guī)格。createReplicationPairNoCG:創(chuàng)建復(fù)制對。deleteReplicationPairNoCG:刪除復(fù)制對。expandReplicationPairNew:復(fù)制對擴(kuò)容。createDisasterRecoveryDrill:創(chuàng)建容災(zāi)演練。deleteDisasterRecoveryDrill:刪除容災(zāi)演練。

begin_time

String

開始時間。默認(rèn)格式為:"yyyy-MM-dd'T'HH:mm:ss.SSSZ",例:"2019-04-01T12:00:00.000Z"。

end_time

String

結(jié)束時間。默認(rèn)格式為:"yyyy-MM-dd'T'HH:mm:ss.SSSZ",例:"2019-04-01T12:00:00.000Z"。

error_code

String

Job執(zhí)行失敗時的錯誤碼。

fail_reason

String

Job執(zhí)行失敗時的錯誤原因。

表6 SubJobEntities

參數(shù)

參數(shù)類型

描述

replication_pair_id

String

復(fù)制對ID

volume_ids

String

組成復(fù)制對的云硬盤ID

server_group_id

String

保護(hù)組ID

protected_instance_id

String

保護(hù)實例ID

native_server_id

String

容災(zāi)站點服務(wù)器ID

nic_id

String

網(wǎng)卡ID

狀態(tài)碼: 400

表7 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表8 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 401

表9 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表10 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 403

表11 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表12 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 405

表13 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表14 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 406

表15 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表16 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 407

表17 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表18 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 408

表19 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表20 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 409

表21 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表22 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 500

表23 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表24 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 501

表25 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表26 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 502

表27 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表28 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 503

表29 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表30 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 504

表31 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表32 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

請求示例

GET https://{endpoint}/v1/{project_id}/jobs/0000000062db92d70162db9d200f000a

響應(yīng)示例

狀態(tài)碼: 200

OK

{
  "status" : "SUCCESS",
  "entities" : {
    "server_group_id" : "a59d008e-4bad-4bf3-9b17-6cc25e7da483"
  },
  "job_id" : "0000000062db92d70162db9d200f000a",
  "job_type" : "createProtectionGroupNoCG",
  "begin_time" : "2018-04-19T01:55:30.443Z",
  "end_time" : "2018-04-19T01:55:45.493Z",
  "error_code" : null,
  "fail_reason" : null
}

狀態(tài)碼

狀態(tài)碼

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

406

Not Acceptable

407

Proxy Authentication Required

408

Request Timeout

409

Conflict

500

Internal Server Error

501

Not Implemented

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

錯誤碼

請參見錯誤碼