Querying Details About a Cloud Phone Server

Function Description

• API name

  GetCloudPhoneServerDetail

• Function

  This API is used to query details about a cloud phone server based on its ID.

URI

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

Request

• Request parameters

  None

• Example request

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

Response

• Response parameters

  Parameter	Type	Description
  request_id	String	Specifies the unique request ID.
  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. For details, see Server Flavors.
  phone_model_name	String	Specifies the cloud phone flavor, which 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 a cloud phone. The name can contain a maximum of 64 bytes.
  status	Integer	Specifies the status of the cloud phone server. 0, 1, 3, or 4: Creating 2: Abnormal 5: Normal 8: Frozen 10: Stopped 11: Being stopped 12: Stopping failed 13: Starting
  vpc_id	String	Specifies the ID of the VPC where the cloud phone server is deployed. When network_version is set to v1, the value of vpc_id is the ID of the tenant VPC to which the cloud phone server belongs. v2, the value of vpc_id is the ID of the VPC specified by the tenant during the cloud phone server creation.
  cidr	String	Specifies the CIDR block of the VPC where the cloud phone server is deployed. When network_version is set to v1, the value of cidr is the CIDR block of the tenant VPC to which the cloud phone server belongs. v2, the value of cidr is the CIDR block of the VPC specified by the tenant during the cloud phone server creation. NOTE: The value of this field is the same as that of vpc_cidr. This field will be discarded later.
  vpc_cidr	String	Specifies the CIDR block of the VPC where the cloud phone server is deployed. When network_version is set to v1, the value of vpc_cidr is the CIDR block of the tenant VPC to which the cloud phone server belongs. v2, the value of vpc_cidr is the CIDR block of the VPC specified by the tenant during the cloud phone server creation.
  subnet_id	String	Specifies the ID of the VPC where the cloud phone server is deployed. Only when network_version is set to v2, the value of subnet_id is the ID of the subnet specified by the tenant during the cloud phone server creation. v1, the value of subnet_id is the ID of the tenant subnet to which the cloud phone server belongs.
  subnet_cidr	String	Specifies the subnet CIDR block where the cloud phone server is deployed. When network_version is set to v2, the value of subnet_cidr is the CIDR block of the subnet specified by the tenant during the cloud phone server creation. v1, the value of subnet_cidr is the CIDR block of the tenant subnet to which the cloud phone server belongs.
  resource_project_id	String	Specifies the project ID of the cloud phone server.
  metadata	Object	Specifies the order and product information. For details, see Table 2.
  addresses	Array of objects	Specifies IP addresses of the cloud phone server. For details, see Table 3.
  band_widths	Array of objects	Specifies the structure array of the bandwidths used by the cloud phone server. For details, see Table 4.
  volumes	Array of objects	Specifies the structure array of volumes used by the cloud phone server. For details, see Table 5.
  network_version	String	Specifies which type of network the cloud phone server uses. The type can be: v1: system network v2: custom network
  enterprise_project_id	String	Specifies the ID of the enterprise project to which the cloud phone server belongs.
  security_groups	Array of strings	Specifies the security group bound to the extension NIC of the cloud phone server. For cloud phone servers that use a custom network, an empty list will be returned for this field.
  create_time	String	Specifies when the cloud phone server was created. It is a UTC time in YYYY-MM-DDTHH:MM:SSZ format.
  update_time	String	Specifies when the cloud phone server was updated. It is a UTC time in YYYY-MM-DDTHH:MM:SSZ format.

  Table 2 Data structure description of metadata

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

  Table 3 Data structure description of address

  Parameter	Type	Description
  intranet_ip	String	Specifies the internal IP address of the cloud phone server. This field has expired.
  access_ip	String	Specifies the public IP address of the cloud phone server. This field has expired.
  server_ip	String	Specifies the internal IP address of the cloud phone server. This field is newly added.
  public_ip	String	Specifies the public IP address of the cloud phone server. This field is newly added.

  Table 4 Data structure description of band_widths

  Parameter	Type	Description
  band_width_name	String	Specifies the bandwidth name of the cloud phone server.
  band_width_id	String	Specifies the unique identifier of the bandwidth used by the cloud phone server.
  band_width_size	Integer	Specifies the bandwidth size of the cloud phone server.
  band_width_charge_mode	Integer	Specifies by which the bandwidth used by the cloud phone server is billed. The value can be: 0: billed by bandwidth 1: billed by traffic
  band_width_share_type	Integer	Specifies the bandwidth type of the cloud phone server. 0: dedicated bandwidth 1: shared bandwidth
  create_time	String	Specifies when the cloud phone server bandwidth was created. It is a UTC time in YYYY-MM-DDTHH:MM:SSZ format.
  update_time	String	Specifies when the cloud phone server bandwidth was updated. It is a UTC time in YYYY-MM-DDTHH:MM:SSZ format.

  Table 5 Data structure description of volumes

  Parameter	Type	Description
  volume_name	String	Specifies the disk name of the cloud phone server.
  volume_id	String	Specifies the unique identifier of the cloud phone server disk.
  volume_size	Integer	Specifies the disk size of the cloud phone server, in GB.
  volume_type	String	Specifies the disk type of the cloud phone server.
  create_time	String	Specifies when the disk was created. It is a UTC time in YYYY-MM-DDTHH:MM:SSZ format.
  update_time	String	Specifies when the disk was updated. It is a UTC time in YYYY-MM-DDTHH:MM:SSZ format.

• Example response

  { 
      "server_name": "cph-418540-1620-40-old-1",
      "availability_zone": "br-iaas-odin1a",
      "addresses": [
          {
              "public_ip": "10.246.xxx.xxx",
              "server_ip": "172.31.22.245",
              "intranet_ip": "172.31.22.245",
              "access_ip": "10.246.xxx.xxx"
          }
      ],
      "metadata": {
          "product_id": "OFFI451249149551403012",
          "order_id": "CS2007271727F9XJE"
      },
      "create_time": "2020-01-01T00:00:00Z",
      "vpc_id": "12021c68-730f-41fa-9884-11c616f4c9ad",
      "phone_model_name": "kg1.cg.c40.d30SSD.e1v1.old",
      "subnet_cidr": "172.31.0.0/16",
      "keypair_name": "KeyPair-1230",
      "resource_project_id": "06a5b529fa80d28b2f53c014024bed44",
      "server_id": "6edb89150bc742aa81fc8ac4ff047297",
      "server_model_name": "physical.kg1.4xlarge.cg",
      "update_time": "2020-01-01T00:00:00Z",
      "cidr": "172.31.0.0/16",
      "vpc_cidr": "172.31.0.0/16",
      "subnet_id": "5784d2fe-fefd-42f0-a7f1-e88454d8bc0f",
      "subnet_cidr": "172.31.0.0/16",
      "request_id": "91d5bf46a817466daa25fc5824ab9717",
      "status": 5,
      "network_version": "v1",
      "enterprise_project_id": "0",
      "security_groups": []
  }

Returned Values

See Returned Values.

Error Codes

See Error Codes.