功能介紹
查詢同一個(gè)request id下的任務(wù)。
調(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}/cloud-phone/jobs
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項(xiàng)目id。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
request_id |
否 |
String |
任務(wù)下發(fā)請(qǐng)求時(shí)響應(yīng)的request_id。request_id和request_ids必須指定其中一個(gè)。request_id和request_ids同時(shí)指定的時(shí)候，以request_ids為準(zhǔn)。 |
|
request_ids |
否 |
String |
任務(wù)下發(fā)請(qǐng)求時(shí)響應(yīng)的多個(gè)request_id，用逗號(hào)分隔，最多不能超過20個(gè)。request_id和request_ids必須指定其中一個(gè)。request_id和request_ids同時(shí)指定的時(shí)候，以request_ids為準(zhǔn)。 |
|
offset |
否 |
Integer |
偏移量為一個(gè)大于0小于資源總個(gè)數(shù)的整數(shù)，表示查詢?cè)撈屏亢竺娴乃械馁Y源數(shù)，默認(rèn)值為0。 |
|
limit |
否 |
Integer |
每頁(yè)返回的資源個(gè)數(shù)。取值范圍：1~100（默認(rèn)值為100），一般設(shè)置為10、20、50。 |
請(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ù)類型 |
描述 |
|---|---|---|
|
request_id |
String |
請(qǐng)求的唯一標(biāo)識(shí)ID。 |
|
jobs |
任務(wù)信息。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
phone_id |
String |
云手機(jī) 的唯一標(biāo)識(shí)，云手機(jī)相關(guān)任務(wù)包含此字段。 |
|
server_id |
String |
云手機(jī)服務(wù)器的唯一標(biāo)識(shí)ID，云手機(jī)服務(wù)器相關(guān)任務(wù)包含此字段。 |
|
node_id |
String |
（已廢棄）云手機(jī)服務(wù)器的唯一標(biāo)識(shí)ID，云手機(jī)服務(wù)含此字段。 |
|
job_id |
String |
任務(wù)的唯一標(biāo)識(shí)。 |
|
begin_time |
String |
任務(wù)處理開始時(shí)間， 時(shí)間格式為UTC，YYYY-MM-DDTHH:MM:SSZ。 |
|
end_time |
String |
任務(wù)處理結(jié)束時(shí)間， 時(shí)間格式為UTC，YYYY-MM-DDTHH:MM:SSZ。 |
|
status |
Integer |
任務(wù)狀態(tài)。
|
|
error_code |
String |
任務(wù)錯(cuò)誤碼。 |
|
error_msg |
String |
任務(wù)錯(cuò)誤碼說明。 |
|
execute_msg |
String |
任務(wù)執(zhí)行返回內(nèi)容，最長(zhǎng)1024個(gè)字節(jié)。 |
請(qǐng)求示例
查詢請(qǐng)求id對(duì)應(yīng)的job狀態(tài)
https://{CPH Endpoint}/v1/{project_id}/cloud-phone/jobs?request_id=6837531fd3f54550927b930180a706bf
響應(yīng)示例
狀態(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 |
錯(cuò)誤碼
請(qǐng)參見錯(cuò)誤碼。
