DescribeAndroidInstances - Cloud Phone - Alibaba Cloud Documentation Center

Returns the details of one or more Elastic Cloud Phone (ECP) instances.

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
InstanceGroupId	string	No	The instance group ID.	ag-25nt4kk9whjh****
KeyPairId	string	No	The ID of the attached key pair.	kp-5hh431emkpuoi****
AndroidInstanceIds	array	No	A list of instance IDs.
	string	No	The instance ID.	acp-25nt4kk9whhok****
AndroidInstanceName	string	No	The instance name.	name
Status	string	No	The instance status. Valid values: BACKUPING : Backing up STARTING : Starting RUNNING : Running DELETING : Deleting BACKUP_FAILED : Backup failed DELETED : Deleted FAILED : Creation failed STOPPED : Stopped RECOVERING : Recovering UNAVAILABLE : Abnormal REBOOTING : Rebooting RESETTING : Resetting STOPPING : Stopping RECOVER_FAILED : Recovery failed CREATING : Creating	RUNNING
SaleMode	string	No	The sale mode. Valid values: Instance : Cloud Phone instance mode Node : Cloud Phone matrix mode	Instance
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 100.	20
NextToken	string	No	The token that indicates the position from which to start the query. If you leave this parameter empty, the query starts from the beginning.	AAAAAV3MpHK1AP0pfERHZN5pu6kw9dGL5jves2FS9RLq****
InstanceGroupIds	array	No	A list of instance group IDs.
	string	No	The instance group ID.	ag-25nt4kk9whhdh****
InstanceGroupName	string	No	The instance group name.	test
ChargeType	string	No	The billing method. Valid values: PostPaid : Pay-as-you-go PrePaid : Subscription	PostPaid
Tag	array<object>	No	The tags of the resource.
	object	No	The tags of the resource.
Key	string	No	The tag key.	key
Value	string	No	The tag value.	value
BizRegionId	string	No	The region ID. You can call DescribeRegions to query the regions where you can purchase Cloud Phone instances.	cn-shanghai
NodeId	string	No	This parameter is not available for public use.	node_id
NodeName	string	No	This parameter is for internal use only.	node_name
OfficeSiteIds	array	No	The Cloud Phone (CP) network ID.
	string	No	The Cloud Phone (CP) network ID.	cn-hangzhou+dir-744962****
AuthorizedUserId	string	No	The ID of the user to whom the instance is assigned. This is the ID of a convenience account.	user
QosRuleIds	array	No	The ID of the Quality of Service (QoS) rule group. This rule applies to instances in the basic shared network.
	string	No	The ID of the QoS rule group.	qos-g6no280ed8byi****
AppManagePolicyId	string	No	The ID of the application management rule.	amp-shigvudbyeuib****
PrivateIpAddress	string	No	The private IP address of the instance.	10.0.162.136

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	F07A1DA1-E1EB-5CCA-8EED-12F85D32****
TotalCount	integer	The total number of entries.	10
NextToken	string	The token that indicates the position where the current query stopped. If this parameter is empty, all data has been read.	AAAAAV3MpHK1AP0pfERHZN5pu6kmma/xxE9WtwL/ADvZ****
InstanceModel	array<object>	The instance information.
	array<object>	The instance information.
AndroidInstanceGroupId	string	The ID of the instance group to which the instance belongs.	ag-ayyhomlal7po****
AndroidInstanceGroupName	string	The instance group name.	AndroidInstanceGroupName
AndroidInstanceId	string	The instance ID.	acp-8at8h6ejkadjh****
AndroidInstanceName	string	The instance name.	name
AndroidInstanceStatus	string	The instance status.	RUNNING
NetworkInterfaceIp	string	The IP address of the network interface.	192.168.22.48
AuthorizedUserId	string	The assigned user.	test
BindUserId	string	The attached user.	test
PersistentAppInstanceId	string	The persistent session ID.	p-0btrd5zj8epo****
AppInstanceId	string	The physical instance ID.	ai-9ey6io0q58rcd****
KeyPairId	string	The key pair ID.	kp-5hh431emkpucs****
GmtCreate	string	The time when the instance was created.	2023-05-06 10:42:10
GmtModified	string	The time when the instance was last modified.	2023-05-06 10:42:10
AppInstanceGroupId	string	The delivery group ID.	aig-i7yv6tkn7kh8dv****
RegionId	string	The region ID.	cn-hangzhou
Rate	integer	The progress of instance data backup or recovery.	100
ErrorCode	string	The reason why instance data backup or recovery failed.	FilePathNotFound
RenderingType	string	The rendering type.	local
InstanceType	string	The instance type.	acp.basic.small
ChargeType	string	The billing method of the instance.	PrePaid
GmtExpired	string	The expiration time of the subscription instance group.	2024-07-15T02:03:33Z
PolicyGroupId	string	The policy group ID.	pg-0bszojpu0seql****
OfficeSiteId	string	The network ID. This ID corresponds to the network (basic shared network or advanced shared network) that you selected in the console when you created the instance.	cn-shenzhen+dir-211620****
VSwitchId	string	The ID of the vSwitch in the virtual private cloud (VPC).	vsw-2zepmau2hsbhos42****
Memory	integer	The memory size. Unit: MiB.	1024
Cpu	string	The number of CPU cores.	4
Disks	array<object>	The disk information.
	object	The disk information.
DiskType	string	The disk type.	SYSTEM
DiskSize	integer	The disk size. Unit: GB.	32
Tags	array<object>	A list of tags.
	object	The tag information.
Key	string	The tag key.	key
Value	string	The tag value.	value
ImageVersion	string	The image version.	3.5.3.867
PublicIpAddress	string	The public IP address.	10.32.1.41
SessionStatus	string	The session connection status. Valid values: disConnect : Disconnected connect : Connected	connect
NetworkInterfaceIpv6Address	string	Note This parameter is not available for public use.	null
PublicIpv6Address	string	Note This parameter is not available for public use.	null
ImageId	string	The image ID.	imgc-075cllfeuazh0****
DisplayConfig	object	The display settings.
ResolutionHeight	integer	The height of the resolution. Unit: pixels.	1280
ResolutionWidth	integer	The width of the resolution. Unit: pixels.	720
Dpi	integer	The DPI.	240
Fps	integer	The frame rate.	30
LockResolution	string	Lock resolution. Valid values: off : off on : on	off
QosRuleId	string	The ID of the QoS rule. This rule applies only to premium bandwidth.	qos-5605u0gelk200****
AppManagePolicy	object	Information about the application management rule. This rule corresponds to the application blacklist and whitelist that you configure in the console.
AppManagePolicyId	string	The ID of the application management rule.	amp-dgiavcvibfdds****
AppManagePolicyName	string	The name of the application management rule.	应用组1
ZoneId	string	The ID of the zone to which the instance belongs.	cn-hangzhou-h
PhoneDataInfo	object	This parameter is for internal use only.
PhoneDataId	string	The ID of the independent phone storage.	pd-sbcudgidbhb****
PhoneDataVolume	integer	The capacity of the independent phone storage. Unit: GiB.	20
StreamMode	integer	This parameter is for internal use only.	1
NetworkType	string	The network type of the instance.	network_pro_ecd
BandwidthPackageType	string	The bandwidth type.	cbwp_ecd
BandwidthPackageId	string	The ID of the bandwidth plan.	np-0q6ixs7vpxcizp***
UpBandwidthLimit	integer	The upstream bandwidth limit. Unit: Mbit/s.	5
DownBandwidthLimit	integer	The downstream bandwidth limit. Unit: Mbit/s.	30
ServerType	string	This parameter is not available for public use.	cpm.gx7.10xlarge
BizTags	array<object>	An array of tags.
	object	The tag object.
Key	string	The tag key.	releaseFlag
Value	string	The tag value.	on
ServerStatus	string	This parameter is for internal use only. Valid values: FAILED : The creation failed. RUNNING : The matrix is running. EXPIRED : The matrix has expired. DELETING : The matrix is being deleted. NODE_READY : The matrix is ready and the instance is being created. CHANGING : The matrix is being upgraded or downgraded. CEASED : The matrix is ceased because of an overdue payment. UPDATING : The image is being updated. CREATING : The matrix is being created. DATA_EXPANDING : The storage is being expanded.	RUNNING
SystemVersion	string	The Android system version.	Android 11
InternetStatus	string
BizImageType	string

Examples

Success response

JSON format

{
  "RequestId": "F07A1DA1-E1EB-5CCA-8EED-12F85D32****",
  "TotalCount": 10,
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kmma/xxE9WtwL/ADvZ****",
  "InstanceModel": [
    {
      "AndroidInstanceGroupId": "ag-ayyhomlal7po****",
      "AndroidInstanceGroupName": "AndroidInstanceGroupName",
      "AndroidInstanceId": "acp-8at8h6ejkadjh****",
      "AndroidInstanceName": "name",
      "AndroidInstanceStatus": "RUNNING",
      "NetworkInterfaceIp": "192.168.22.48",
      "AuthorizedUserId": "test",
      "BindUserId": "test",
      "PersistentAppInstanceId": "p-0btrd5zj8epo****",
      "AppInstanceId": "ai-9ey6io0q58rcd****",
      "KeyPairId": "kp-5hh431emkpucs****",
      "GmtCreate": "2023-05-06 10:42:10",
      "GmtModified": "2023-05-06 10:42:10",
      "AppInstanceGroupId": "aig-i7yv6tkn7kh8dv****",
      "RegionId": "cn-hangzhou",
      "Rate": 100,
      "ErrorCode": "FilePathNotFound",
      "RenderingType": "local",
      "InstanceType": "acp.basic.small",
      "ChargeType": "PrePaid",
      "GmtExpired": "2024-07-15T02:03:33Z",
      "PolicyGroupId": "pg-0bszojpu0seql****",
      "OfficeSiteId": "cn-shenzhen+dir-211620****",
      "VSwitchId": "vsw-2zepmau2hsbhos42****",
      "Memory": 1024,
      "Cpu": "4",
      "Disks": [
        {
          "DiskType": "SYSTEM",
          "DiskSize": 32
        }
      ],
      "Tags": [
        {
          "Key": "key",
          "Value": "value"
        }
      ],
      "ImageVersion": "3.5.3.867",
      "PublicIpAddress": "10.32.1.41",
      "SessionStatus": "connect",
      "NetworkInterfaceIpv6Address": "null",
      "PublicIpv6Address": "null",
      "ImageId": "imgc-075cllfeuazh0****",
      "DisplayConfig": {
        "ResolutionHeight": 1280,
        "ResolutionWidth": 720,
        "Dpi": 240,
        "Fps": 30,
        "LockResolution": "off"
      },
      "QosRuleId": "qos-5605u0gelk200****",
      "AppManagePolicy": {
        "AppManagePolicyId": "amp-dgiavcvibfdds****",
        "AppManagePolicyName": "应用组1"
      },
      "ZoneId": "cn-hangzhou-h",
      "PhoneDataInfo": {
        "PhoneDataId": "pd-sbcudgidbhb****",
        "PhoneDataVolume": 20
      },
      "StreamMode": 1,
      "NetworkType": "network_pro_ecd",
      "BandwidthPackageType": "cbwp_ecd",
      "BandwidthPackageId": "np-0q6ixs7vpxcizp***",
      "UpBandwidthLimit": 5,
      "DownBandwidthLimit": 30,
      "ServerType": "cpm.gx7.10xlarge",
      "BizTags": [
        {
          "Key": "releaseFlag",
          "Value": "on"
        }
      ],
      "ServerStatus": "RUNNING",
      "SystemVersion": "Android 11",
      "InternetStatus": "",
      "BizImageType": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.