Build Android Instance Groups at Scale via API - Cloud Phone - Alibaba Cloud - Cloud Phone

Creates pay-as-you-go or subscription cloud phone instance groups. An instance group can manage multiple instances. You can organize instances with the same functional purpose into the same instance group for unified management.

Operation description

When you create a cloud phone instance group, note that creating an instance group incurs resource charges. Familiarize yourself with the billable methods of cloud phone instance groups in advance.

If the billing method of the instance group is subscription (PrePaid), the default value of AutoPay is false. After you invoke this operation, go to Expenses and Costs to manually pay for the order.
If you want to enable automatic payment, set AutoPay to true.

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	Yes	The region ID. You can call DescribeRegions to query the list of regions where cloud phone instances can be purchased. Valid values: cn-shenzhen : Shenzhen. cn-beijing : Beijing. cn-shanghai : Shanghai. cn-hongkong : China (Hong Kong) ap-southeast-1 : Singapore. cn-hangzhou : Hangzhou.	cn-hangzhou
InstanceGroupName	string	No	The instance group name. Note The instance group name cannot exceed 30 characters in length. It must start with an uppercase letter, lowercase letter, or Chinese character. It cannot start with `http://` or `https://`. It can contain Chinese characters, letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).	Cloud phoneA
NumberOfInstances	integer	No	The number of instances in the instance group. Maximum value: 100.	1
ChargeType	string	No	The billing type. Valid values: PostPaid : pay-as-you-go. PrePaid : subscription.	PostPaid
Period	integer	No	The subscription duration of the resource. The unit is specified by PeriodUnit.	1
PeriodUnit	string	No	The unit of the subscription duration. Valid values: Month : month. Year : year. Hour : hour. This value can be used only for the pay-as-you-go billing method.	Month
InstanceGroupSpec	string	Yes	The instance group specification. You can call DescribeSpec to query the specifications available for cloud phone instances. Valid values: acp.perf.large : Performance (8 vCPUs, 16 GiB memory, 32 GiB storage) acp.basic.small : Lightweight (2 vCPUs, 4 GiB memory, 32 GiB storage) acp.std.large : Standard (4 vCPUs, 8 GiB memory, 32 GiB storage)	acp.basic.small
AutoPay	boolean	No	Specifies whether to enable automatic payment. Default value: false. Valid values: true : Automatic payment is enabled. Make sure that your account has a sufficient balance. false : Manual payment is required.	false
AutoRenew	boolean	No	Specifies whether to enable auto-renewal. Default value: false. Valid values: true : Auto-renewal is enabled. The subscription resource is automatically renewed upon expiration. false : The subscription resource must be manually renewed upon expiration.	false
OfficeSiteId	string	No	The network ID. To create a shared network instance: the network ID is optional. Specify the network ID of the Shared Network type on the Cloud Phone console > Network page. If no shared network exists in the console, you can leave this parameter empty. A shared network is automatically created when the instance group is created. To create a VPC network instance: the network ID is required. Specify the network ID of the VPC Network type on the Cloud Phone console > Network page. If no VPC network exists in the console, create a network first.	cn-hangzhou+dir-745976****
VSwitchId	string	No	The vSwitch ID. You can call DescribeVSwitches to query the list of vSwitches. To create a shared network instance: leave this parameter empty. To create a VPC network instance: the vSwitch ID is required. The specified vSwitch is used to create the instance.	vsw-uf61uvzhz8ejaw776****
PolicyGroupId	string	No	The policy ID. You can call ListPolicyGroups to query the list of policies.	pg-b7bxrrwxkijjh****
ImageId	string	Yes	The image ID. You can call DescribeImageList to query the list of cloud phone images.	imgc-06zyt9m93zwax****
Amount	integer	No	The number of instance groups. Default value: 1. Maximum value: 100.	8
GpuAcceleration	boolean	No	Specifies whether to enable GPU acceleration. Valid values: true : Enabled. false : Disabled. [Default value]	false
KeyPairId	string	No	The key pair ID. If you specify a valid key pair ID when creating an instance group, the key pair is bound to all instances that are successfully created, without the need to call the bindng operation again. Note Binding a key pair during scale-out is not supported.	kp-7o9xywwfutc1l****
ClientToken	string	No	The client token that is used to ensure the idempotence of the request and prevent repeated submissions. The value cannot exceed 100 characters in length.	asadbuvwiabdbvchj****
EnableIpv6	boolean	No	Note This parameter is not publicly available.	null
Ipv6Bandwidth	integer	No	Note This parameter is not publicly available.	null
Tag	array<object>	No	The tags of the resource.
	object	No	The tags of the resource.
Value	string	No	The tag value.	value
Key	string	No	The tag key.	key
NetworkInfo	object	No
BandwidthPackageName	string	No
CidrBlock	string	No
LimitedBandwidth	integer	No
InternetChargeType	string	No
IpRatio	integer	No
Isp	string	No
PayType	string	No
Period	integer	No
PeriodUnit	string	No
AutoPay	boolean	No
AutoRenew	boolean	No
VisibleType	string	No
PromotionId	string	No
PaidCallbackUrl	string	No
BandwidthPackageType	string	No
BandwidthPackageId	string	No
NetworkType	string	No
PromotionId	string	No
StreamMode	integer	No
PaidCallBackUrl	string	No		wya.wuying.aliyun.com/instanceGroup
SaleMode	string	No
InstanceVersion	string	No

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1A923337-44D9-5CAD-9A53-95084BD4****
InstanceGroupInfos	array<object>	The instance group information.
	object
InstanceGroupId	string	The instance group ID.	ag-cuv4scs4obxch****
InstanceIds	array	The list of instance IDs.
	string	The instance ID.	acp-g40b9at5nhjo9****
OrderId	string	The order ID.	22365781890****
InstanceGroupIds	array	The list of instance group IDs.
	string	The instance group ID.	ag-cuv4scs4obxch****
NetworkPackageOrderModel	object
BandwidthPackageOrderId	string
BandwidthPackageId	string

Examples

Success response

JSON format

{
  "RequestId": "1A923337-44D9-5CAD-9A53-95084BD4****",
  "InstanceGroupInfos": [
    {
      "InstanceGroupId": "ag-cuv4scs4obxch****",
      "InstanceIds": [
        "acp-g40b9at5nhjo9****"
      ]
    }
  ],
  "OrderId": "22365781890****",
  "InstanceGroupIds": [
    "ag-cuv4scs4obxch****"
  ],
  "NetworkPackageOrderModel": {
    "BandwidthPackageOrderId": "",
    "BandwidthPackageId": ""
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.