Querying cloud phone servers

Function

This API is used to query cloud phone servers by page and list them by creation time in descending order. You can specify offset and limit. If no cloud phone server is found, an empty list will be returned.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	If the offset is 0 (default value) or an integer greater than 0, all resources after the offset will be queried.
limit	No	Integer	Specifies the number of resources returned on each page. The value ranges from 1 to 100 (default). Generally, this parameter is set to 10, 20, or 50.
server_name	No	String	Specifies the name of the cloud phone server. Fuzzy query is supported.
server_id	No	String	Specifies the unique identifier of the cloud phone server.
network_version	No	String	Specifies whether the cloud phone server is a user-defined network ID. v1: cloud phone server on the system-defined network v2: cloud phone server on a user-defined network
phone_model_name	No	String	Specifies the cloud phone specifications name.
create_since	No	Long	Specifies the start time of the query.
create_until	No	Long	Specifies the end time of the query.
status	No	Integer	Specifies the cloud phone server status. 0, 1, 3, and 4: creating 2: abnormal 5: normal 8: frozen 10: stopped 11: being stopped 12: stop failed 13: starting

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling an Identity and Access Management (IAM) API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the unique request ID.
count	Integer	Specifies the total number of cloud phone servers.
servers	Array of Server objects	Specifies the information about the cloud phone servers.

**Table 5** Server
Parameter	Type	Description
server_name	String	Specifies the name of the cloud phone server. The name can contain a maximum of 65 characters, including only letters, digits, underscores (_), and hyphens (-).
availability_zone	String	Specifies the AZ where the cloud phone server is deployed.
server_id	String	Specifies the unique identifier of the cloud phone server. The identifier can contain a maximum of 32 bytes.
server_model_name	String	Specifies the flavor of the cloud phone server. The flavor can contain a maximum of 64 bytes.
phone_model_name	String	Specifies the cloud phone flavor. The value can contain a maximum of 64 bytes.
keypair_name	String	Specifies the name of the key pair used to connect to the cloud phone. The value can contain a maximum of 64 bytes.
status	Integer	Specifies the Server status. 0, 1, 3, 4: creating 2: abnormal 5: normal 8: frozen 10: powered off 11: powering off 12: Failed to shut down the VM. 13: being started
vpc_id	String	Specifies the ID of the VPC to which the cloud phone server belongs. If network_version is set to v1, this parameter indicates the VPC ID of the resource tenant to which the cloud phone server belongs. If network_version is set to v2, this parameter indicates the VPC ID specified by the tenant during server creation.
cidr	String	Specifies the network segment of the VPC to which the cloud phone server belongs. If network_version is set to v1, this parameter indicates the VPC CIDR of the resource tenant to which the cloud phone server belongs. If network_version is set to v2, this parameter indicates the VPC CIDR of the VPC specified by the tenant during server creation.
vpc_cidr	String	Specifies the CIDR block of the VPC where the cloud phone server is deployed. When network_version is set to v1, this parameter indicates the CIDR block of a resource tenant VPC. When network_version is set to v2, this parameter indicates the CIDR block of a tenant VPC.
subnet_id	String	Specifies the ID of the subnet to which the cloud phone server belongs. If network_version is set to v2, this parameter indicates the subnet ID specified when a tenant creates a server. If network_version is set to v1, this parameter indicates the subnet ID of the resource tenant to which the cloud phone server belongs.
subnet_cidr	String	Specifies the subnet segment to which the cloud phone server belongs. If network_version is set to v2, this parameter indicates the CIDR of the subnet specified when a tenant creates a server. If network_version is set to v1, this parameter indicates the CIDR of the subnet of the resource tenant to which the cloud phone server belongs.
addresses	Array of Address objects	Specifies the IP address of the cloud phone server.
resource_project_id	String	Specifies the project ID of the cloud phone server.
metadata	metadata object	Specifies the order and product information.
network_version	String	Specifies whether the cloud phone server is a user-defined network. v1: cloud phone server on a non-user-defined network. v2: cloud phone server on a user-defined network. Data can be filtered by network version.
enterprise_project_id	String	Specifies the ID of the enterprise project to which the cloud phone server belongs.
create_time	String	Creation Time, The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.
update_time	String	Update Time, The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

**Table 6** Address
Parameter	Type	Description
intranet_ip	String	(Expired) Specifies the private IP address of the cloud phone server.
access_ip	String	(Expired) Specifies the public IP address of the cloud phone server.
server_ip	String	(New) Specifies the private IP address of the cloud phone server.
public_ip	String	(New) Specifies the public IP address of the cloud phone server.

**Table 7** metadata
Parameter	Type	Description
product_id	String	Specifies the product ID, which can contain a maximum of 64 bytes.
order_id	String	Specifies the order ID, which can contain a maximum of 64 bytes.

Example Requests

Querying cloud phone servers

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

Example Responses

Status code: 200

{
  "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",
      "charging_mode" : 0
    },
    "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",
      "charging_mode" : 0
    },
    "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
}