功能介紹
分頁查詢 云手機 服務器，云手機服務器列表按照創(chuàng)建時間進行降序排列。分頁查詢可以指定offset以及l(fā)imit。如果不存在云手機服務器，則返回空列表。
調試
您可以在API Explorer中調試該接口，支持自動認證鑒權。API Explorer可以自動生成SDK代碼示例，并提供SDK代碼示例調試功能。
URI
GET /v1/{project_id}/cloud-phone/servers
|
參數 |
是否必選 |
參數類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項目id。 |
|
參數 |
是否必選 |
參數類型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
偏移量為一個大于0小于資源總個數的整數，表示查詢該偏移量后面的所有的資源數，默認值為0。 |
|
limit |
否 |
Integer |
每頁返回的資源個數。取值范圍：1~100（默認值為100），一般設置為10、20、50。 |
|
server_name |
否 |
String |
云手機服務器名稱，支持模糊查詢。 |
|
server_id |
否 |
String |
云手機服務器的唯一標識。 |
|
network_version |
否 |
String |
云手機服務器是否為自定義網絡標識。
|
請求參數
|
參數 |
是否必選 |
參數類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。 通過調用 IAM 服務獲取用戶Token接口獲?。憫㈩^中X-Subject-Token的值）。 |
響應參數
狀態(tài)碼： 200
|
參數 |
參數類型 |
描述 |
|---|---|---|
|
request_id |
String |
請求的唯一標識ID。 |
|
count |
Integer |
實例總數。 |
|
servers |
云手機服務器信息。 |
|
參數 |
參數類型 |
描述 |
|---|---|---|
|
server_name |
String |
云手機服務器名稱，不超過65字符，只支持英文字母、數字、漢字、下劃線和中劃線。 |
|
availability_zone |
String |
云手機服務器所在的可用區(qū)。 |
|
server_id |
String |
云手機服務器的唯一標識，不超過32個字節(jié)。 |
|
server_model_name |
String |
云手機服務器規(guī)格名稱，不超過64個字節(jié)。 |
|
phone_model_name |
String |
云手機規(guī)格名稱，不超過64個字節(jié)。 |
|
keypair_name |
String |
連接云手機所使用的密鑰對的名稱，不超過64個字節(jié)。 |
|
status |
Integer |
服務器狀態(tài)。
|
|
vpc_id |
String |
云手機服務器所屬 虛擬私有云 （簡稱VPC）的ID。 網絡版本network_version取值為“v1”時，表示云手機服務器所屬資源租戶的VPC ID；取值為“v2”時，表示租戶創(chuàng)建服務器時指定VPC的 VPC ID。 |
|
cidr |
String |
云手機服務器所屬虛擬 私有云 （簡稱VPC）的網段。網絡版本 network_version 取值為“v1”時，表示云手機服務器所屬資源租戶的VPC CIDR；取值為“v2”時，表示租戶創(chuàng)建服務器時指定 VPC 的 VPC CIDR。 |
|
vpc_cidr |
String |
云手機服務器所屬虛擬私有云（簡稱VPC 網絡版本 network_version 取值為“v1”時，表示云手機服務器所屬資源租戶的VPC CIDR；取值為“v2”時，表示租戶創(chuàng)建服務器時指定 VPC 的 VPC CIDR |
|
subnet_id |
String |
云手機服務器所屬子網的ID。僅在網絡版本 network_version 取值為“v2”時，該取值表示租戶創(chuàng)建服務器時指定子網的 ID，網絡版本取值為“v1”時，該字段表示云手機服務器所屬資源租戶的子網ID。 |
|
subnet_cidr |
String |
云手機服務器所屬子網網段。網絡版本 network_version 取值為“v2”時，表示租戶創(chuàng)建服務器時指定子網的 CIDR; 取值為“v1”時，表示云手機服務器所屬資源租戶的子網CIDR。 |
|
addresses |
云手機服務器的IP相關信息。 |
|
|
resource_project_id |
String |
云手機服務器的項目ID。 |
|
metadata |
訂單以及產品相關信息。 |
|
|
network_version |
String |
是否為自定義網絡的云手機服務器標識。"v1"，非自定義網絡的云手機服務器。 "v2"，自定義網絡的云手機服務器。支持按照網絡版本字段進行篩選。 |
|
enterprise_project_id |
String |
云手機服務器所屬企業(yè)項目ID。 |
|
create_time |
String |
創(chuàng)建時間， 時間格式為UTC，YYYY-MM-DDTHH:MM:SSZ。 |
|
update_time |
String |
更新時間， 時間格式為UTC，YYYY-MM-DDTHH:MM:SSZ。 |
|
參數 |
參數類型 |
描述 |
|---|---|---|
|
intranet_ip |
String |
云手機服務器的內網IP，過期字段。 |
|
access_ip |
String |
云手機服務器的 公網IP ，過期字段。 |
|
server_ip |
String |
云手機服務器的內網IP，新增字段。 |
|
public_ip |
String |
云手機服務器的公網IP，新增字段。 |
請求示例
查詢服務器列表
GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/servers
響應示例
狀態(tài)碼： 200
OK
{
"servers" : [ {
"server_name" : "cph-edgr-1",
"server_id" : "4aff349ab539452a85ac5d7442b39377",
"server_model_name" : "physical.rx1.xlarge",
"phone_model_name" : "rx1.cp.c105.d6.e5v5",
"keypair_name" : "keypair01",
"status" : 2,
"vpc_id" : "9a11e291-967f-4dd6-99bd-9be54f10583c",
"cidr" : "192.168.0.0/16",
"vpc_cidr" : "192.168.0.0/16",
"subnet_id" : "c7f9983d-03ca-4a2e-a0e1-d6bd97174669",
"subnet_cidr" : "192.168.0.0/24",
"addresses" : [ {
"intranet_ip" : "192.168.0.62",
"server_ip" : "192.168.0.62",
"access_ip" : "10.246.175.190",
"public_ip" : "10.246.175.190"
}, {
"intranet_ip" : "192.168.0.169",
"server_ip" : "192.168.0.169",
"access_ip" : "10.246.171.245",
"public_ip" : "10.246.171.245"
} ],
"resource_project_id" : "06a5b529fa80d28b2f53c014024bed44",
"metadata" : {
"product_id" : "00301-221014-0--0",
"order_id" : "CS21111116336E8RX"
},
"availability_zone" : "br-iaas-odin1a",
"network_version" : "v2",
"create_time" : "2021-11-11T08:33:40Z",
"update_time" : "2021-11-11T09:28:30Z"
}, {
"server_name" : "cph-igfp-2",
"server_id" : "6d74b672216d40f39377a99e7f95aa95",
"server_model_name" : "physical.kg1m.4xlarge.cg",
"phone_model_name" : "kg1m.cg.c60.d20SSD.e1v1",
"keypair_name" : "KeyPair-2",
"status" : 2,
"vpc_id" : "12021c68-730f-41fa-9884-11c616f4c9ad",
"cidr" : "172.31.0.0/16",
"vpc_cidr" : "172.31.0.0/16",
"subnet_id" : "92cf2447-163c-4fe8-897b-fd262ab6b134",
"subnet_cidr" : "172.31.0.0/16",
"addresses" : [ {
"intranet_ip" : "172.31.185.82",
"access_ip" : "88.88.48.151",
"server_ip" : "172.31.185.82",
"public_ip" : "88.88.48.151"
} ],
"resource_project_id" : "06a5b529fa80d28b2f53c014024bed44",
"metadata" : {
"product_id" : "OFFI635412973496623104",
"order_id" : "CS21083015171L1CA"
},
"availability_zone" : "br-iaas-odin1a",
"network_version" : "v1",
"create_time" : "2021-08-30T07:17:40Z",
"update_time" : "2021-11-05T09:07:57Z"
} ],
"request_id" : "4336f6c61d2048c6b58b4368d9d95ecd",
"count" : 2
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
錯誤碼
請參見錯誤碼。
