All Products
Search

This Product

    Cloud Phone:DescribeAndroidInstanceGroups

    Document Center

    Cloud Phone:DescribeAndroidInstanceGroups

    Last Updated:Dec 04, 2025

    Retrieves the details of Android instance groups.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    BizRegionId

    string

    No

    The region ID.

    cn-hangzhou

    InstanceGroupIds

    array

    No

    The list of instance group IDs.

    string

    No

    The instance group ID.

    ag-25nt4kk9whhdh****

    InstanceGroupName

    string

    No

    The name of the instance group. Fuzzy search is supported.

    云手机

    Status

    string

    No

    The status of the instance group.

    Valid values:

    • UPDATING_FAILED :

      The image update failed.

    • FAILED :

      The creation failed.

    • RUNNING :

      Active.

    • EXPIRED :

      Expired.

    • DELETING :

      Deleting.

    • DELETED :

      Deleted.

    • UPDATING :

      Updating the image.

    • CREATING :

      Creating.

    CREATING

    SaleMode

    string

    No

    The purchase mode of the Android instances.

    Valid values:

    • Instance :

      (Default) standard mode

    • Node :

    standard

    ChargeType

    string

    No

    The billing method.

    Valid values:

    • PrePaid :

      Subscription.

    • PostPaid :

      Pay-as-you-go.

    PostPaid

    PolicyGroupId

    string

    No

    The policy ID.

    pg-1b77w6xrqfubi****

    KeyPairId

    string

    No

    The ID of the key pair.

    kp-5htf0ymsrnb7q****

    MaxResults

    integer

    No

    The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 100.

    10

    NextToken

    string

    No

    The token that specifies the start of the next page of results. If you leave this parameter empty, the query starts from the beginning.

    AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****

    Tags

    array<object>

    No

    The tags of the instance group. You can specify up to 20 tags for each instance.

    object

    No

    The tag information.

    Key

    string

    No

    The tag key. You can specify 1 to 20 tag keys.

    Important

    The tag key can be up to 128 characters in length. It cannot start with aliyun or acs: and cannot contain http:// or https://.

    phone

    Value

    string

    No

    The tag value.

    Important

    The tag value can be up to 128 characters in length. It cannot start withaliyun oracs: and cannot containhttp:// orhttps://.

    2025

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    F07A1DA1-E1EB-5CCA-8EED-12F85D32****

    TotalCount

    integer

    The total number of entries.

    10

    NextToken

    string

    The token that is used to start the next query. If this parameter is not returned, it indicates that all results have been returned.

    AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****

    InstanceGroupModel

    array<object>

    The details of the instance group.

    array<object>

    The details of the instance group.

    InstanceGroupId

    string

    The instance group ID.

    ag-h67a2cs0zprfdh****

    InstanceGroupName

    string

    The instance group name.

    云手机A

    InstanceGroupStatus

    string

    The status of the instance group.

    RUNNING

    InstanceGroupSpec

    string

    The instance group specification.

    acp.basic.small

    InstanceGroupSpecDescribe

    string

    The description of the instance group specification.

    ARM-2vCPU4GiB 32GiB

    OfficeSiteId

    string

    The network ID.

    cn-shanghai+dir-030598****

    ImageId

    string

    The image ID.

    imgc-06zyt9m93zwax****

    NumberOfInstances

    string

    The number of instances in the instance group.

    10

    ChargeType

    string

    The billing method.

    PrePaid

    RegionId

    string

    The region ID.

    cn-hangzhou

    GmtCreate

    string

    The time when the instance group was created.

    2024-02-01 10:56:36

    GmtModified

    string

    The time when the instance group was last updated.

    2024-02-01 10:56:36

    SaleMode

    string

    The sales mode.

    standard

    InstalledAppList

    string

    The list of installed applications.

    "抖音","淘宝"

    GmtExpired

    string

    The expiration time of the subscription instance group.

    2027-06-29 07:25:31

    AppInstanceGroupId

    string

    The delivery group ID.

    aig-48xr63m4dybjk****

    PolicyGroupId

    string

    The policy ID.

    pg-c6n38xucps8kl****

    VSwitchId

    string

    The ID of the vSwitch in the virtual private cloud (VPC).

    vsw-t4n0yqs009ho024wt****

    ResolutionHeight

    integer

    The vertical resolution.

    1280

    ResolutionWidth

    integer

    The horizontal resolution.

    720

    SystemVersion

    string

    The system version.

    Android 12

    ArchitectureType

    string

    The architecture type.

    ARM

    Memory

    integer

    The memory size.

    8

    Cpu

    string

    The number of CPU cores.

    8

    Disks

    array<object>

    The disk information.

    object

    The disk information.

    DiskType

    string

    The disk type.

    SYSTEM

    DiskSize

    integer

    The disk size. Unit: GB.

    32

    ErrorCode

    string

    The reason why the creation failed.

    InternalError

    RenderingType

    string

    The rendering mode of the instance group.

    Valid values:

    • GPURemote :

      GPU remote rendering

    • CPU :

      CPU rendering

    • GPULocal :

      GPU local rendering

    CPU

    AvailableInstanceAmount

    integer

    The number of available instances.

    Note

    An instance is considered available if its status is not `Deleting` or `Deleted`.

    2

    EnableIpv6

    boolean

    Note

    This parameter is not yet available to the public.

    true

    Ipv6Bandwidth

    integer

    Note

    This parameter is not yet available to the public.

    50

    BandwidthPackageId

    string

    The ID of the bandwidth plan.

    np-0q6ixs7vpxciz****

    BandwidthPackageType

    string

    The type of the bandwidth plan.

    cbwp_ecd

    BandwidthPackageStatus

    string

    The status of the bandwidth plan. Valid values:

    • Creating: The bandwidth plan is being created.

    • Releasing: The bandwidth plan is being released.

    • InUse: The bandwidth plan is in use.

    • Failed: The bandwidth plan failed to be created.

    • Expired: The bandwidth plan has expired.

    • Available: The bandwidth plan is unattached and is being billed.

    Creating

    NetworkType

    string

    The network type of the instance.

    Note

    Currently, this parameter is returned only for instance groups that use standard networks.

    network_pro_ecd

    ImageVersion

    string

    The image version.

    25.09.2

    BindQosRules

    object

    The information about the Internet traffic throttling rules for the instance group.

    totalCount

    integer

    The total number of Internet traffic throttling rules for the instance group.

    2

    InstanceQosRule

    array<object>

    The information about the Internet traffic throttling rules that are attached to the instance.

    object

    InstanceId

    string

    The instance ID.

    acp-h3m8b5dusopp5****

    QosRuleId

    string

    The ID of the Internet traffic throttling rule. This rule applies only to premium bandwidth.

    qos-3kh93uu0vdbka****

    Tags

    array<object>

    The tag information.

    object

    The tag information.

    Key

    string

    The tag key.

    phone

    Value

    string

    The tag value.

    2025

    ZoneId

    string

    The zone ID.

    cn-hangzhou-j

    Examples

    Success response

    JSON format

    {
  "RequestId": "F07A1DA1-E1EB-5CCA-8EED-12F85D32****",
  "TotalCount": 10,
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****",
  "InstanceGroupModel": [
    {
      "InstanceGroupId": "ag-h67a2cs0zprfdh****\n",
      "InstanceGroupName": "云手机A",
      "InstanceGroupStatus": "RUNNING",
      "InstanceGroupSpec": "acp.basic.small",
      "InstanceGroupSpecDescribe": "ARM-2vCPU4GiB 32GiB",
      "OfficeSiteId": "cn-shanghai+dir-030598****",
      "ImageId": "imgc-06zyt9m93zwax****",
      "NumberOfInstances": "10",
      "ChargeType": "PrePaid",
      "RegionId": "cn-hangzhou",
      "GmtCreate": "2024-02-01 10:56:36",
      "GmtModified": "2024-02-01 10:56:36",
      "SaleMode": "standard",
      "InstalledAppList": "\"抖音\",\"淘宝\"",
      "GmtExpired": "2027-06-29 07:25:31",
      "AppInstanceGroupId": "aig-48xr63m4dybjk****",
      "PolicyGroupId": "pg-c6n38xucps8kl****",
      "VSwitchId": "vsw-t4n0yqs009ho024wt****",
      "ResolutionHeight": 1280,
      "ResolutionWidth": 720,
      "SystemVersion": "Android 12",
      "ArchitectureType": "ARM",
      "Memory": 8,
      "Cpu": "8",
      "Disks": [
        {
          "DiskType": "SYSTEM",
          "DiskSize": 32
        }
      ],
      "ErrorCode": "InternalError",
      "RenderingType": "CPU",
      "AvailableInstanceAmount": 2,
      "EnableIpv6": true,
      "Ipv6Bandwidth": 50,
      "BandwidthPackageId": "np-0q6ixs7vpxciz****",
      "BandwidthPackageType": "cbwp_ecd",
      "BandwidthPackageStatus": "Creating",
      "NetworkType": "network_pro_ecd",
      "ImageVersion": "25.09.2",
      "BindQosRules": {
        "totalCount": 2,
        "InstanceQosRule": [
          {
            "InstanceId": "acp-h3m8b5dusopp5****",
            "QosRuleId": "qos-3kh93uu0vdbka****"
          }
        ]
      },
      "Tags": [
        {
          "Key": "phone",
          "Value": "2025"
        }
      ],
      "ZoneId": "cn-hangzhou-j"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.