Querying the Cloud Phone Server Details

Function Description

  • API Name

    GetCloudPhoneServerDetail

  • Function

    Query details about a Cloud Phone server based on the server ID.

URI

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

For details, see Table 1.
Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

For details about how to obtain the project ID, see Obtaining a Project ID.

server_id

Yes

String

Specifies the unique identifier of the Cloud Phone server.

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 request ID, which is unique.

    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 flavor name of the Cloud Phone server. 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 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 2.

    addresses

    Array of objects

    Specifies the IP address of the Cloud Phone server. For details, see Table 3.

    create_time

    String

    Specifies the time when the Cloud Phone server is created.

    The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

    update_time

    String

    Specifies the time when the Cloud Phone server is updated.

    The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

    Table 2 metadata field description

    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. The value can contain a maximum of 64 bytes.

    probation_begin_time

    String

    Specifies the cloud phone trial start time.

    The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

    probation_end_time

    String

    Specifies the cloud phone trial end time.

    The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

    Table 3 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
    { 
        "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",
        "request_id": "91d5bf46a817466daa25fc5824ab9717",
        "status": 5
    }

Returned Value

See Returned Values.

Error Codes

See Error Codes.