Querying the Cloud Phone Flavors

Function Description

  • API Name

    ListCloudPhoneModels

  • Function

    Query the cloud phone flavors.

URI

GET /v1/{project_id}/cloud-phone/phone-models?status={status}

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.

status

No

Integer

Specifies the flavor status.

  • 1: normal
  • 0: offline

If this parameter is not specified, flavors in all states are queried.

Request

  • Request parameters

    None

  • Example request
    1
    GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phone-models
    

Response

  • Parameter description

    Parameter

    Type

    Description

    request_id

    String

    Specifies the request ID, which is unique.

    phone_model

    Array of objects

    Specifies the cloud phone flavor. For details, see Table 2.

    Table 2 phone_model field description

    Parameter

    Type

    Description

    server_model_name

    String

    Specifies the flavor the cloud phone server. The value 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.

    spec_code

    String

    Specifies the flavor name. The value can contain a maximum of 64 bytes.

    cpu

    Integer

    Specifies the number of CPU cores.

    memory

    Integer

    Specifies the memory size in GB.

    disk

    Integer

    Specifies the storage size in GB.

    resolution

    String

    Specifies the cloud phone resolution. The value can contain a maximum of 16 bytes.

    extend_spec

    jsonString

    Specifies the cloud phone extended configuration. The value can contain a maximum of 512 bytes.

    phone_capacity

    Integer

    Specifies the number of cloud phones of the current flavor.

    status

    Integer

    Specifies the flavor status.

    • 1: normal
    • 0: offline

    The cloud phone flavors that have been brought offline cannot be selected when you purchase cloud phone servers.

    product_type

    Integer

    Specifies the cloud phone type.

    • 0: cloud phone
    • 1: cloud mobile gaming phone

    image_label

    String

    Specifies the image type. The following types are supported:

    • qemu_phone
    • cloud_phone
    • cloud_game
  • Example response
    {
        "phone_models": [
            {
                "server_model_name": "physical.rx1.xlarge",
                "phone_model_name": "rx1.cp.c60.d32.e1v1.qemu",
                "status": 1,
                "cpu": 2.0,
                "memory": 3072,
                "disk": 32,
                "resolution": "540x960",
                "extend_spec": "{\"eip_count\": 1, \"vip_count\":1, \"emulator_type\":0,  \"bms_image_id\":\"72460777-7fcb-4cae-8bb5-62d93be86bd7\",\"core_bind_strategy\":\"lxc_qemu_common_hosted_c60\", \"sd_disk\": 1}",
                "spec_code": "rx1.cp.c60.d32.e1v1.qemu",
                "phone_capacity": 60,
                "image_label": "qemu_phone",
                "product_type": 0
            },
            {
                "server_model_name": "physical.rx1.xlarge",
                "phone_model_name": "rx1.cp.c60.d10.e1v1",
                "status": 1,
                "cpu": 2.0,
                "memory": 3584,
                "disk": 10,
                "resolution": "720x1280",
                "extend_spec": "{\"eip_count\": 1, \"vip_count\":1, \"emulator_type\":1,\"thinpool_size_g\":70, \"sharepool_size_g\":650,\"max_share_disk_size_g\":50,\"encode_server_spec\": {\"cpu\": 2,\"memory\": 14448,\"disk\": 10,\"image_id\":\"coderserver_v2.5\", \"port_num\":0},\"core_bind_strategy\":\"common_hosted_c60\"}",
                "spec_code": "rx1.cp.c60.d10.e1v1",
                "phone_capacity": 60,
                "image_label": "cloud_phone",
                "product_type": 0
            }
        ],
        "request_id": "e0dd77cb688743468599487ca2a1c738"
    }

Returned Values

See Returned Values.

Error Codes

See Error Codes.