Retrieve ECP Instance Status via DescribeAndroidInstances API - Cloud Phone - Alibaba Cloud - Cloud Phone

Queries the details of cloud phone 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 bound key pair.	kp-5hh431emkpuoi****
AndroidInstanceIds	array	No	The 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 : file backup in progress. STARTING : starting. RUNNING : available. DELETING : deleting. BACKUP_FAILED : file backup failed. DELETED : deleted. FAILED : creation failed. STOPPED : stopped. RECOVERING : file recovery in progress. UNAVAILABLE : abnormal. REBOOTING : rebooting. RESETTING : resetting. STOPPING : stopping. RECOVER_FAILED : file recovery failed. CREATING : creating.	RUNNING
SaleMode	string	No	The sales mode. Valid values: Instance : cloud phone instance mode. Node : cloud phone matrix mode.	Instance
MaxResults	integer	No	The maximum number of entries per page for a paged query. Valid values: 1 to 100. Default value: 100.	20
NextToken	string	No	The pagination token that indicates the position from which to start reading. Leave this parameter empty to start reading from the beginning.	AAAAAV3MpHK1AP0pfERHZN5pu6kw9dGL5jves2FS9RLq****
InstanceGroupIds	array	No	The 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 type. 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 list of regions that support purchasing cloud phones..	cn-shanghai
NodeId	string	No	This parameter is not publicly available..	node_id
NodeName	string	No	This parameter is not publicly available..	node_name
OfficeSiteIds	array	No	The cloud phone network ID.
	string	No	The cloud phone network ID.	cn-hangzhou+dir-744962****
AuthorizedUserId	string	No	The user ID assigned to the instance, which is the China Wuying convenience account ID.	user
QosRuleIds	array	No	The public network rate limiting rule group ID. The rate limiting rule for instances in the basic shared network.
	string	No	The public network rate limiting rule group ID.	qos-g6no280ed8byi****
AppManagePolicyId	string	No	The application management policy ID.	amp-shigvudbyeuib****
PrivateIpAddress	string	No	The private IP address of the instance.	10.0.162.136
SortKey	string	No
SortType	string	No
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 to which the current call has read. An empty value indicates that 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 bound 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 creation time.	2023-05-06 10:42:10
GmtModified	string	The modification time.	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 error reason for instance data backup failure or recovery failure.	FilePathNotFound
RenderingType	string	The rendering type.	local
InstanceType	string	The instance type.	acp.basic.small
ChargeType	string	The billing type 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 corresponds to the network selected during creation in the console (basic shared network or advanced shared network).	cn-shenzhen+dir-211620****
VSwitchId	string	The vSwitch ID in the VPC.	vsw-2zepmau2hsbhos42****
Memory	integer	The memory size.	1024
Cpu	string	The number of CPU cores.	4
Disks	array<object>	The disk information.
	object	The disk information.
DiskType	string	The type of the disk.	SYSTEM
DiskSize	integer	The size of the disk, in GB.	32
Tags	array<object>	The 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 publicly available.	null
PublicIpv6Address	string	Note This parameter is not publicly available.	null
ImageId	string	The image ID.	imgc-075cllfeuazh0****
DisplayConfig	object	The display settings.
ResolutionHeight	integer	The vertical resolution, in pixels.	1280
ResolutionWidth	integer	The horizontal resolution, in pixels.	720
Dpi	integer	The dots per inch (DPI).	240
Fps	integer	The frame rate.	30
LockResolution	string	Specifies whether to lock the resolution. Valid values: off : The resolution is not locked. on : The resolution is locked.	off
QosRuleId	string	The public network rate limiting rule ID (applies only to premium bandwidth).	qos-5605u0gelk200****
AppManagePolicy	object	The application management policy information. This corresponds to the blacklists and whitelists management of application management policies in the console.
AppManagePolicyId	string	The ID of the application management rule.	amp-dgiavcvibfdds****
AppManagePolicyName	string	The name of the application management rule.	Application group 1
ZoneId	string	The zone ID to which the instance belongs.	cn-hangzhou-h
PhoneDataInfo	object	This parameter is not publicly available..
PhoneDataId	string	The ID of the independent device storage.	pd-sbcudgidbhb****
PhoneDataVolume	integer	The capacity of the independent device storage, in GiB.	20
StreamMode	integer	This parameter is not publicly available..	1
NetworkType	string	The network type of the instance.	network_pro_ecd
BandwidthPackageType	string	The bandwidth type.	cbwp_ecd
BandwidthPackageId	string	The bandwidth package ID.	np-0q6ixs7vpxcizp***
UpBandwidthLimit	integer	The upstream bandwidth throttling. Unit: Mbit/s.	5
DownBandwidthLimit	integer	The downstream bandwidth throttling. Unit: Mbit/s.	30
ServerType	string	This parameter is not publicly available..	cpm.gx7.10xlarge
BizTags	array<object>	The tag array.
	object	The tag object.
Key	string	The tag key.	releaseFlag
Value	string	The tag value.	on
ServerStatus	string	This parameter is not publicly available.. Valid values: FAILED : creation failed. RUNNING : available. EXPIRED : expired. DELETING : deleting. NODE_READY : matrix ready, instances being created. CHANGING : matrix specification change in progress. CEASED : overdue. UPDATING : image update in progress. CREATING : creating. DATA_EXPANDING : storage expansion in progress.	RUNNING
SystemVersion	string	The Android system version.	Android 11
InternetStatus	string
BizImageType	string
Channel	string
PackageId	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": "Application group 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": "",
      "Channel": "",
      "PackageId": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.