Help Center> Cloud Phone Host> API Reference> APIs for Cloud Mobile Gaming Management> Application Management> Querying the List of Cloud Phones Where Applications Are Deployed
View PDF

Querying the List of Cloud Phones Where Applications Are Deployed

Function Description

  • API Name

    QueryAppDeployPhones

  • Function

    Query the list of cloud phones where applications are deployed. A maximum of 100 records can be returned for each request.

URI

GET /v1/{project_id}/cloud-phone/apps/{app_id}/phones?offset=0&limit=100

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.

app_id

Yes

String

Specifies the application ID. The value can contain a maximum of 32 characters.

offset

No

Integer

Offset

If the value is an integer greater than 0 but less than the number of resources, all resources after this offset will be queried. The default value is 0.

limit

No

Integer

Specifies the number of resources returned on each page.

Value range: 1–100 (default value: 100)

Generally, set this parameter to 10, 20, or 50.

Request

  • Request parameters

    None

  • Example request 
    1
    		 
    GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/apps/{app_id}/phones?offset=0&limit=100

Response

  • Response parameters

    Parameter

    Type

    Description

    request_id

    String

    Specifies the request ID, which is unique.

    phones

    Array of objects

    Specifies the cloud phone information. For details, see Table 2.
    Table 2 phone field description

    Parameter

    Type

    Description

    phone_id

    String

    Specifies the unique identifier of the cloud phone.

    app_version_id

    String

    Specifies the application package name.

    version_code

    String

    Specifies the application version code.

    version_name

    String

    Specifies the application version name.

    launch_activity

    String

    Specifies the application startup path.
  • Example response 
    {
    "request_id": "6a63a18b8bab40ffb71ebd9cb80d0085",
    "phones": [{
        "phone_id": "88b8449b896f3a4f0ad57222dd91909",
        "app_verison_id": "",
        "version_code": "",
        "version_name": "",
        "launch_activity":"xxx",
    },
    {
        "phone_id": "88b8449b896f3a4f0ad57222dd91909",
        "app_verison_id": "",
        "version_code": "",
        "version_name": "",
        "launch_activity":"xxx",
    }]
}

Returned Values

See Returned Values.

Error Codes

See Error Codes.

Parent topic: Application Management