華為云計算 云知識 查詢任務執(zhí)行狀態(tài)列表ListJobs
查詢任務執(zhí)行狀態(tài)列表ListJobs

 

功能介紹

查詢同一個request id下的任務。

調試

您可以在API Explorer中調試該接口,支持自動認證鑒權。API Explorer可以自動生成SDK代碼示例,并提供SDK代碼示例調試功能。

URI

GET /v1/{project_id}/cloud-phone/jobs

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項目id。

表2 Query參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

request_id

String

任務下發(fā)請求時響應的request_id。request_id和request_ids必須指定其中一個。request_id和request_ids同時指定的時候,以request_ids為準。

request_ids

String

任務下發(fā)請求時響應的多個request_id,用逗號分隔,最多不能超過20個。request_id和request_ids必須指定其中一個。request_id和request_ids同時指定的時候,以request_ids為準。

offset

Integer

偏移量為一個大于0小于資源總個數(shù)的整數(shù),表示查詢該偏移量后面的所有的資源數(shù),默認值為0。

limit

Integer

每頁返回的資源個數(shù)。取值范圍:1~100(默認值為100),一般設置為10、20、50。

請求參數(shù)

表3 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。 通過調用 IAM 服務獲取用戶Token接口獲?。憫㈩^中X-Subject-Token的值)。

響應參數(shù)

狀態(tài)碼: 200

表4 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

request_id

String

請求的唯一標識ID。

jobs

Array of Job objects

任務信息。

表5 Job

參數(shù)

參數(shù)類型

描述

phone_id

String

云手機 的唯一標識,云手機相關任務包含此字段。

server_id

String

云手機服務器的唯一標識ID,云手機服務器相關任務包含此字段。

node_id

String

(已廢棄)云手機服務器的唯一標識ID,云手機服務含此字段。

job_id

String

任務的唯一標識。

begin_time

String

任務處理開始時間, 時間格式為UTC,YYYY-MM-DDTHH:MM:SSZ。

end_time

String

任務處理結束時間, 時間格式為UTC,YYYY-MM-DDTHH:MM:SSZ。

status

Integer

任務狀態(tài)。

  • 1 :運行中

  • 2 : 成功

  • -1 :失敗

error_code

String

任務錯誤碼。

error_msg

String

任務錯誤碼說明。

execute_msg

String

任務執(zhí)行返回內容,最長1024個字節(jié)。

請求示例

查詢請求id對應的job狀態(tài)

https://{CPH Endpoint}/v1/{project_id}/cloud-phone/jobs?request_id=6837531fd3f54550927b930180a706bf

響應示例

狀態(tài)碼: 200

OK

{
  "request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085",
  "jobs" : [ {
    "phone_id" : "1234567b8bab40ffb711234cb80d0234",
    "server_id" : "1e223c8e-3ad0-4bf0-a837-bc90d4f91d01",
    "node_id" : "1e223c8e-3ad0-4bf0-a837-bc90d4f91d01",
    "job_id" : "1564567b8bab40f34711234cb80d0123",
    "begin_time" : "2017-10-25T00:00:00Z",
    "end_time" : "2017-10-25T00:00:30Z",
    "status" : -1,
    "error_code" : "CPS0005",
    "error_msg" : "Phone not found."
  }, {
    "phone_id" : "abc4567b8bab40ffb711234cb80d0abc",
    "server_id" : "1e223c8e-3ad0-4bf0-a837-bc90d4f91d01",
    "node_id" : "1e223c8e-3ad0-4bf0-a837-bc90d4f91d01",
    "job_id" : "1564567b8bab40f34711234cb80d0456",
    "begin_time" : "2017-10-25T00:00:00Z",
    "end_time" : "2017-10-25T00:00:32Z",
    "status" : 2,
    "error_code" : "",
    "error_msg" : ""
  } ]
}

狀態(tài)碼

狀態(tài)碼

描述

200

OK

錯誤碼

請參見錯誤碼。