華為云計(jì)算 云知識(shí) 查詢(xún)?cè)剖謾C(jī)服務(wù)器列表ListCloudPhoneServers
查詢(xún)?cè)剖謾C(jī)服務(wù)器列表ListCloudPhoneServers

 

功能介紹

分頁(yè)查詢(xún) 云手機(jī) 服務(wù)器,云手機(jī)服務(wù)器列表按照創(chuàng)建時(shí)間進(jìn)行降序排列。分頁(yè)查詢(xún)可以指定offset以及l(fā)imit。如果不存在云手機(jī)服務(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/servers

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

project_id

String

項(xiàng)目id。

表2 Query參數(shù)

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

offset

Integer

偏移量為一個(gè)大于0小于資源總個(gè)數(shù)的整數(shù),表示查詢(xún)?cè)撈屏亢竺娴乃械馁Y源數(shù),默認(rèn)值為0。

limit

Integer

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

server_name

String

云手機(jī)服務(wù)器名稱(chēng),支持模糊查詢(xún)。

server_id

String

云手機(jī)服務(wù)器的唯一標(biāo)識(shí)。

network_version

String

云手機(jī)服務(wù)器是否為自定義網(wǎng)絡(luò)標(biāo)識(shí)。

  • v1:系統(tǒng)定義網(wǎng)絡(luò)的云手機(jī)服務(wù)器

  • v2:自定義網(wǎng)絡(luò)的云手機(jī)服務(wù)器

請(qǐng)求參數(shù)

表3 請(qǐng)求Header參數(shù)

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

X-Auth-Token

String

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

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

狀態(tài)碼: 200

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

參數(shù)

參數(shù)類(lèi)型

描述

request_id

String

請(qǐng)求的唯一標(biāo)識(shí)ID。

count

Integer

實(shí)例總數(shù)。

servers

Array of Server objects

云手機(jī)服務(wù)器信息。

表5 Server

參數(shù)

參數(shù)類(lèi)型

描述

server_name

String

云手機(jī)服務(wù)器名稱(chēng),不超過(guò)65字符,只支持英文字母、數(shù)字、漢字、下劃線和中劃線。

availability_zone

String

云手機(jī)服務(wù)器所在的可用區(qū)。

server_id

String

云手機(jī)服務(wù)器的唯一標(biāo)識(shí),不超過(guò)32個(gè)字節(jié)。

server_model_name

String

云手機(jī)服務(wù)器規(guī)格名稱(chēng),不超過(guò)64個(gè)字節(jié)。

phone_model_name

String

云手機(jī)規(guī)格名稱(chēng),不超過(guò)64個(gè)字節(jié)。

keypair_name

String

連接云手機(jī)所使用的密鑰對(duì)的名稱(chēng),不超過(guò)64個(gè)字節(jié)。

status

Integer

服務(wù)器狀態(tài)。

  • 0、1、3、4:創(chuàng)建中

  • 2:異常

  • 5:正常

  • 8:凍結(jié)

  • 10:關(guān)機(jī)

  • 11:關(guān)機(jī)中

  • 12:關(guān)機(jī)失敗

  • 13:開(kāi)機(jī)中

vpc_id

String

云手機(jī)服務(wù)器所屬 虛擬私有云 (簡(jiǎn)稱(chēng)VPC)的ID。 網(wǎng)絡(luò)版本network_version取值為“v1”時(shí),表示云手機(jī)服務(wù)器所屬資源租戶(hù)的VPC ID;取值為“v2”時(shí),表示租戶(hù)創(chuàng)建服務(wù)器時(shí)指定VPC的 VPC ID。

cidr

String

云手機(jī)服務(wù)器所屬虛擬 私有云 (簡(jiǎn)稱(chēng)VPC)的網(wǎng)段。網(wǎng)絡(luò)版本 network_version 取值為“v1”時(shí),表示云手機(jī)服務(wù)器所屬資源租戶(hù)的VPC CIDR;取值為“v2”時(shí),表示租戶(hù)創(chuàng)建服務(wù)器時(shí)指定 VPC 的 VPC CIDR。

vpc_cidr

String

云手機(jī)服務(wù)器所屬虛擬私有云(簡(jiǎn)稱(chēng)VPC 網(wǎng)絡(luò)版本 network_version 取值為“v1”時(shí),表示云手機(jī)服務(wù)器所屬資源租戶(hù)的VPC CIDR;取值為“v2”時(shí),表示租戶(hù)創(chuàng)建服務(wù)器時(shí)指定 VPC 的 VPC CIDR

subnet_id

String

云手機(jī)服務(wù)器所屬子網(wǎng)的ID。僅在網(wǎng)絡(luò)版本 network_version 取值為“v2”時(shí),該取值表示租戶(hù)創(chuàng)建服務(wù)器時(shí)指定子網(wǎng)的 ID,網(wǎng)絡(luò)版本取值為“v1”時(shí),該字段表示云手機(jī)服務(wù)器所屬資源租戶(hù)的子網(wǎng)ID。

subnet_cidr

String

云手機(jī)服務(wù)器所屬子網(wǎng)網(wǎng)段。網(wǎng)絡(luò)版本 network_version 取值為“v2”時(shí),表示租戶(hù)創(chuàng)建服務(wù)器時(shí)指定子網(wǎng)的 CIDR; 取值為“v1”時(shí),表示云手機(jī)服務(wù)器所屬資源租戶(hù)的子網(wǎng)CIDR。

addresses

Array of Address objects

云手機(jī)服務(wù)器的IP相關(guān)信息。

resource_project_id

String

云手機(jī)服務(wù)器的項(xiàng)目ID。

metadata

metadata object

訂單以及產(chǎn)品相關(guān)信息。

network_version

String

是否為自定義網(wǎng)絡(luò)的云手機(jī)服務(wù)器標(biāo)識(shí)。"v1",非自定義網(wǎng)絡(luò)的云手機(jī)服務(wù)器。 "v2",自定義網(wǎng)絡(luò)的云手機(jī)服務(wù)器。支持按照網(wǎng)絡(luò)版本字段進(jìn)行篩選。

enterprise_project_id

String

云手機(jī)服務(wù)器所屬企業(yè)項(xiàng)目ID。

create_time

String

創(chuàng)建時(shí)間, 時(shí)間格式為UTC,YYYY-MM-DDTHH:MM:SSZ。

update_time

String

更新時(shí)間, 時(shí)間格式為UTC,YYYY-MM-DDTHH:MM:SSZ。

表6 Address

參數(shù)

參數(shù)類(lèi)型

描述

intranet_ip

String

云手機(jī)服務(wù)器的內(nèi)網(wǎng)IP,過(guò)期字段。

access_ip

String

云手機(jī)服務(wù)器的 公網(wǎng)IP ,過(guò)期字段。

server_ip

String

云手機(jī)服務(wù)器的內(nèi)網(wǎng)IP,新增字段。

public_ip

String

云手機(jī)服務(wù)器的公網(wǎng)IP,新增字段。

表7 metadata

參數(shù)

參數(shù)類(lèi)型

描述

product_id

String

訂單ID,不超過(guò)64個(gè)字節(jié)。

order_id

String

產(chǎn)品ID,不超過(guò)64個(gè)字節(jié)。

請(qǐng)求示例

查詢(xún)服務(wù)器列表

GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/servers

響應(yīng)示例

狀態(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

錯(cuò)誤碼

請(qǐng)參見(jiàn)錯(cuò)誤碼。