DescribeAndroidInstanceGroups API Reference - Cloud Phone - Alibaba Cloud - Cloud Phone

Queries the details of cloud phone 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 instance group name. Fuzzy match is supported.	Cloud phone
Status	string	No	The instance group status. Valid values: UPDATING_FAILED : image update failed. FAILED : creation failed. RUNNING : active. EXPIRED : expired. DELETING : being deleted. DELETED : deleted. UPDATING : image update in progress. CREATING : being created.	CREATING
SaleMode	string	No	The purchase mode of the cloud phone. Valid values: STANDARD : Standard mode [default value]	standard
ChargeType	string	No	The billing type. [_single.params.ChargeType.enum. PrePaid]subscription Valid values: PrePaid : 包年包月 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 per page for a paged query. Valid values: 1 to 100. Default value: 100.	10
NextToken	string	No	The pagination token that indicates the position from which to start reading. An empty value indicates reading from the beginning.	AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****
Tags	array<object>	No	The tags of the instance group. You can bind up to 20 tags to 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 with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	2025
InstanceVersion	string	No

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 pagination token that indicates the position up to which data has been read in the current call. An empty value indicates that all data has been read.	AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****
InstanceGroupModel	array<object>	The details of the instance groups.
	array<object>	The details of the instance groups.
InstanceGroupId	string	The instance group ID.	ag-h67a2cs0zprfdh****
InstanceGroupName	string	The instance group name.	Cloud phoneA
InstanceGroupStatus	string	The instance group status.	RUNNING
InstanceGroupSpec	string	The instance group specifications.	acp.basic.small
InstanceGroupSpecDescribe	string	The description of the instance group specifications.	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 creation time.	2024-02-01 10:56:36
GmtModified	string	The update time.	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 vSwitch ID in the VPC.	vsw-t4n0yqs009ho024wt****
ResolutionHeight	integer	The height of the resolution.	1280
ResolutionWidth	integer	The width of the 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, in GB.	32
ErrorCode	string	The reason for the creation failure.	InternalError
RenderingType	string	The rendering method 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 Available means the instance status is not "being deleted" or "deleted".	2
EnableIpv6	boolean	Note This parameter is not publicly available.	true
Ipv6Bandwidth	integer	Note This parameter is not publicly available.	50
BandwidthPackageId	string	The ID of the bandwidth package.	np-0q6ixs7vpxciz****
BandwidthPackageType	string	The type of the bandwidth package.	cbwp_ecd
BandwidthPackageStatus	string	The status of the bandwidth package. Valid values: Creating: being created. Releasing: being released. InUse: in use. Failed: failed. Expired: expired. Available: unbound and being billed.	Creating
NetworkType	string	The network type of the instance. Note This field is returned only for instance groups with standard networking.	network_pro_ecd
ImageVersion	string	The image version.	25.09.2
BindQosRules	object	The public network bandwidth limit rules for the instance group.
totalCount	integer	The total number of public network bandwidth throttling rules for the instance group.	2
InstanceQosRule	array<object>	The public network bandwidth throttling rules bound to the instance.
	object
InstanceId	string	The instance ID.	acp-h3m8b5dusopp5****
QosRuleId	string	The ID of the public network bandwidth throttling rule. This rule applies only to premium bandwidth.	qos-3kh93uu0vdbka****
ZoneId	string	The zone ID.	cn-hangzhou-j
Tags	array<object>	The tag information.
	object	The tag information.
Key	string	The tag key.	phone
Value	string	The tag value.	2025
Channel	string
PackageId	string

Examples

Success response

JSON format

{
  "RequestId": "F07A1DA1-E1EB-5CCA-8EED-12F85D32****",
  "TotalCount": 10,
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****",
  "InstanceGroupModel": [
    {
      "InstanceGroupId": "ag-h67a2cs0zprfdh****\n",
      "InstanceGroupName": "Cloud phoneA",
      "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****"
          }
        ]
      },
      "ZoneId": "cn-hangzhou-j",
      "Tags": [
        {
          "Key": "phone",
          "Value": "2025"
        }
      ],
      "Channel": "",
      "PackageId": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.