Querying Cloud Phone Details

Function

This API is used to query cloud phone details.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v1/{project_id}/cloud-phone/phones/{phone_id}

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

Request Parameters

**Table 2** 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 3** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the unique identifier of the cloud phone. The value can contain a maximum of 32 bytes.
phone_name	String	Specifies the cloud phone name. The value can contain a maximum of 65 bytes.
server_id	String	Specifies the cloud phone server ID, which can contain a maximum of 32 bytes.
phone_id	String	Specifies the unique identifier of the cloud phone. The value can contain a maximum of 32 bytes.
image_id	String	Specifies the cloud phone image ID, which can contain a maximum of 32 bytes.
image_version	String	Specifies the image version.
vnc_enable	String	Whether to enable the VNC service on the cloud phone (expired) - true: enable - false: disable
phone_model_name	String	Specifies the cloud phone flavor. The value can contain a maximum of 64 bytes.
status	Integer	Specifies the cloud phone status. 1: creating 2: running 3: resetting 4: restarting 6: frozen 7: stopping 8: stopped -5: reset failed -6: restart failed -7: abnormal -8: creation failed -9: stop failed
access_infos	Array of PhoneAccessInfo objects	Specifies the cloud phone access information.
property	String	Specifies the cloud phone attribute character string. The value can contain a maximum of 2048 bytes.
metadata	metadata object	Specifies the order and product information.
phone_data_volume	PhoneDataVolume object	Specifies the data disk information of the cloud phone.
imei	String	Specifies the cloud phone IMEI.
type	Integer	Specifies the cloud phone type. 0: common cloud phone
traffic_type	String	Specifies the cloud phone route type. direct: default route routing: Traffic is routed to the encoding container.
volume_mode	Integer	Specifies whether the physical disk of the cloud phone is independent. 0: not independent 1: independent
availability_zone	String	AZ where the cloud phone server is located. For example, the name for AZ 1 in the CN East-Shanghai1 region is cn-east-3a.
has_encrypt	Boolean	Specifies whether file-level encryption is enabled on the cloud phone.
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 4** PhoneAccessInfo
Parameter	Type	Description
type	String	Specifies the user-defined port type. The value can contain a maximum of 16 bytes.
device_ip	String	(Expired) Specifies the cloud phone IP address.
phone_ip	String	Specifies the cloud phone IP address.
listen_port	Integer	Specifies the listening port of a program that is enabled in a cloud phone to provide services.
access_ip	String	(Expired) Specifies the IP address for accessing the cloud phone server.
public_ip	String	Specifies the public IP address of the cloud phone server. If non-public access is configured for the access port, an empty string is returned.
intranet_ip	String	(Expired) Specifies the private IP address of the cloud phone server.
server_ip	String	Specifies the private IP address of the cloud phone server.
access_port	Integer	Specifies the access port of a program that is mapped to a port on the public network. The program is enabled in a cloud phone to provide services.
phone_ipv6	String	(New) Specifies the cloud phone IPv6 address.
server_ipv6	String	(New) Specifies the IPv6 address of the cloud phone server.

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

**Table 6** PhoneDataVolume
Parameter	Type	Description
volume_type	String	Specifies the data disk type of the cloud phone.
volume_size	Integer	Specifies the data disk size of the cloud phone.

Example Requests

Querying cloud phone details

GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/1564567b8bab40f34711234cb80d8574

Example Responses

Status code: 200

{
  "request_id" : "70bb40bef50e4a14b116a5a527fd7432",
  "phone_name" : "mobile-0049",
  "server_id" : "88b8449b896f3a4f0ad57222dd91909",
  "phone_id" : "1564567b8bab40f34711234cb80d8574",
  "image_id" : "88b8449b896f3a4f0ad57222dd91909",
  "phone_model_name" : "aphs1.large.2.aosp",
  "image_version" : "AOSP 7.0",
  "status" : 2,
  "imei" : 869287243397729,
  "type" : 0,
  "availability_zone" : "xxxxxx",
  "traffic_type" : "direct",
  "volume_mode" : 0,
  "phone_data_volume" : {
    "volume_type" : "GPSSD",
    "volume_size" : 10
  },
  "access_infos" : [ {
    "type" : "server1",
    "device_ip" : "10.237.0.61",
    "phone_ip" : "10.237.0.61",
    "listen_port" : 38080,
    "access_ip" : "213.32.43.210",
    "public_ip" : "213.32.43.210",
    "intranet_ip" : "172.31.0.123",
    "server_ip" : "172.31.0.123",
    "access_port" : 14308,
    "phone_ipv6" : "fd00::aed:3d",
    "server_ipv6" : "2001:db8:a583:b62:e5ea:4a6b:de7b:f97d"
  }, {
    "type" : "server2",
    "device_ip" : "10.237.0.61",
    "phone_ip" : "10.237.0.61",
    "listen_port" : 38081,
    "access_ip" : "213.32.43.210",
    "public_ip" : "213.32.43.210",
    "intranet_ip" : "172.31.0.123",
    "server_ip" : "172.31.0.123",
    "access_port" : 14328,
    "phone_ipv6" : "fd00::aed:3d",
    "server_ipv6" : "2001:db8:a583:b62:e5ea:4a6b:de7b:f97d"
  } ],
  "property" : "{\"sys.prop.writephonenum\":\"13666666666\",\"sys.prop.writeimsi\":\"460021624617113\",\"sys.prop.writewifissid\":\"test_wifi\"}",
  "metadata" : {
    "order_id" : "CS1710111105S8IPB",
    "product_id" : "00301-25217-0--0"
  },
  "create_time" : "2017-10-10T00:00:00Z",
  "update_time" : "2018-11-12T00:00:00Z"
}