Function Description

• API Name

  ListCloudPhoneServers

• Function

  Query the Cloud Phone servers by page. The Cloud Phone servers are sorted in descending order of the creation time. You can specify the values of offset and limit. If no Cloud Phone server exists, an empty list is returned.

URI

GET /v1/{project_id}/cloud-phone/servers?offset={offset}&limit={limit}&server_name={server_name}

Request

• Request parameters

  None

• Example request

  1	GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/servers?offset=0&limit=10

Response

• Parameter description

  Parameter	Type	Description
  request_id	String	Specifies the request ID, which is unique.
  servers	Array of objects	Specifies the information about the Cloud Phone server. For details, see Table 2.

  Table 2 server field description

  Parameter	Type	Description
  server_name	String	Specifies the Cloud Phone server name. The value 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 located.
  server_id	String	Specifies the unique identifier of the Cloud Phone server. The value can contain a maximum of 32 bytes.
  server_model_name	String	Specifies the Cloud Phone server flavor. The value can contain a maximum of 64 bytes. For details, see Server Flavors.
  phone_model_name	String	Specifies the cloud phone flavor. The value can contain a maximum of 64 bytes. For details, see Cloud Phone Flavor List.
  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 Cloud Phone server status. 0, 1, 3, and 4: Creating 2: Abnormal 5: Normal 8: Frozen 10: Stopped
  vpc_id	String	Specifies the ID of the Virtual Private Cloud (VPC) which the Cloud Phone server belongs to.
  resource_project_id	String	Specifies the project ID of the Cloud Phone server.
  cidr	String	Specifies the VPC CIDR block which the Cloud Phone server belongs to.
  metadata	Object	Specifies the order and product information. For details, see Table 3.
  addresses	Array of objects	Specifies the IP address of the Cloud Phone server. For details, see Table 4.
  create_time	String	Specifies the time when the Cloud Phone server is created in UTC format, YYYY-MM-DDTHH:MM:SSZ.
  update_time	String	Specifies the time when the Cloud Phone server is updated in UTC format, YYYY-MM-DDTHH:MM:SSZ.

  Table 3 metadata field description

  Parameter	Type	Description
  order_id	String	Specifies the order ID, which contains a maximum of 64 bytes.
  product_id	String	Specifies the product ID, which contains a maximum of 64 bytes.
  probation_begin_time	String	Specifies the cloud phone trial start time in UTC format, YYYY-MM-DDTHH:MM:SSZ.
  probation_end_time	String	Specifies the cloud phone trial end time in UTC format, YYYY-MM-DDTHH:MM:SSZ.

  Table 4 address field description

  Parameter	Type	Description
  intranet_ip (expired)	String	Specifies the internal IP address of the Cloud Phone server.
  access_ip (expired)	String	Specifies the public IP address of the Cloud Phone server.
  server_ip (new)	String	Specifies the internal IP address of the Cloud Phone server.
  public_ip (new)	String	Specifies the public IP address of the Cloud Phone server.

• Example response

  {
      "request_id": "6a63a18b8bab40ffb71ebd9cb80d0085",
      "servers": [
          {
              "server_name": "server-1",
              "availability_zone": "br-iaas-1",
              "server_id" : "88b8449b896f3a4f0ad57222dd91909",
              "server_model_name": "physical.rx1.xlarge",
              "phone_model_name": "aphs1.medium.4.aosp",
              "keypair_name": "",
              "status": 5,
              "vpc_id": "6e3feb2c-b9c9-4ac5-abf1-96d60e3dfea2",
              "resource_project_id": "2347275010d3440d963d3fcb8931ff55",
              "cidr": "172.31.0.0/16",
              "metadata": {
                  "order_id": "CS1710111105S8IPB", 
                  "product_id": "00301-25217-0--0"
              },
              "addresses": [ {
                  "intranet_ip": "10.237.0.111",
                  "access_ip": "122.237.0.111",
                  "server_ip": "10.237.0.111",
                  "public_ip": "122.237.0.111"
              } ],
              "create_time": "2017-10-10T00:00:00Z",
              "update_time": "2018-10-10T00:00:00Z"
          },
          { 
              "server_name": "server-2",
              "availability_zone": "br-iaas-2",
              "server_id" : "88b8449b896f3a4f0ad57222dd91909",
              "server_model_name": "physical.rx1.xlarge",
              "phone_model_name": "aphs1.large.2.aosp",
              "keypair_name": "",
              "status": 2, 
              "vpc_id": "6e3feb2c-b9c9-4ac5-abf1-96d60e3dfea2",
              "resource_project_id": "2347275010d3440d963d3fcb8931ff55",
              "cidr": "172.31.0.0/16",
              "metadata": { 
                  "order_id": "CS1710111105S8IPB", 
                  "product_id": "00301-25217-0--0"
              }, 
              "addresses": [ {            
                "intranet_ip": "10.237.0.123",
                "access_ip": "122.237.0.123",
                "server_ip": "10.237.0.123",
                "public_ip": "122.237.0.123"
              } ],
              "create_time": "2017-10-10T00:00:00Z",
              "update_time": "2018-11-12T00:00:00Z"
          }
      ]
  }

Returned Values

See Returned Values.

Error Codes

See Error Codes.