功能介紹
分頁(yè)查詢 云手機(jī) ，云手機(jī)列表按照創(chuàng)建時(shí)間進(jìn)行降序排列。分頁(yè)查詢可以指定offset以及l(fā)imit。如果不存在云手機(jī)，則返回空列表。
調(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/phones
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項(xiàng)目id。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
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。 |
|
phone_name |
否 |
String |
云手機(jī)名稱，支持模糊查詢。 |
|
server_id |
否 |
String |
云手機(jī)服務(wù)器的唯一標(biāo)識(shí)。 |
|
status |
否 |
Integer |
云手機(jī)狀態(tài)。
|
|
type |
否 |
Integer |
云手機(jī)類型。
|
請(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ù)類型 |
描述 |
|---|---|---|
|
phones |
云手機(jī)信息。 |
|
|
request_id |
String |
請(qǐng)求的唯一標(biāo)識(shí)ID。 |
|
count |
Integer |
實(shí)例總數(shù)。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
phone_name |
String |
云手機(jī)的名稱，不超過65個(gè)字符。 |
|
server_id |
String |
云手機(jī)所在的服務(wù)器ID，不超過32個(gè)字節(jié)。 |
|
phone_id |
String |
云手機(jī)的唯一標(biāo)識(shí)，不超過32個(gè)字節(jié)。 |
|
phone_model_name |
String |
云手機(jī)規(guī)格名稱，不超過64個(gè)字節(jié)。 |
|
image_id |
String |
云手機(jī) 鏡像 ID，不超過32個(gè)字節(jié)。 |
|
vnc_enable |
String |
云手機(jī)是否開啟VNC服務(wù)。
|
|
status |
Integer |
云手機(jī)狀態(tài)。
|
|
type |
Integer |
云手機(jī)類型。
|
|
metadata |
訂單以及產(chǎn)品相關(guān)信息。 |
|
|
create_time |
String |
創(chuàng)建時(shí)間， 時(shí)間格式為UTC。 |
|
update_time |
String |
更新時(shí)間， 時(shí)間格式為UTC。 |
請(qǐng)求示例
查詢手機(jī)列表
GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones
響應(yīng)示例
狀態(tài)碼： 200
OK
{
"request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085",
"count" : 1,
"phones" : [ {
"phone_name" : "mobile-0001",
"server_id" : "88b8449b896f3a4f0ad57222dd91909",
"phone_id" : "1234567b8bab40ffb711234cb80d0234",
"phone_model_name" : "AOSP-1U4G15G-001",
"image_id" : "88b8449b896f3a4f0ad57222dd91909",
"vnc_enable" : "true",
"status" : 2,
"type" : 0,
"metadata" : {
"order_id" : "CS1710111105S8IPB",
"product_id" : "00301-25217-0--0"
},
"create_time" : "2017-10-10T00:00:00Z",
"update_time" : "2018-10-10T00:00:00Z"
} ]
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
錯(cuò)誤碼
請(qǐng)參見錯(cuò)誤碼。
