CreateAndroidInstanceGroup - Cloud Phone - Alibaba Cloud Documentation Center

Creates pay-as-you-go or subscription cloud phone instance groups. An instance group can manage multiple instances. You can add instances with similar features to the same group to simplify management.

Operation description

Note that creating an instance group incurs charges. Make sure that you understand the billing rules for cloud phone instance groups before you proceed.

If the billing method for the instance group is subscription (PrePaid), the AutoPay parameter is set to false by default. After you call the API, go to Alibaba Cloud Expenses and Costs to manually pay for the order.
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. Call DescribeRegions to query the list of regions where you can purchase cloud phones. Valid values: cn-shenzhen : China (Shenzhen) cn-beijing : China (Beijing) cn-shanghai : China (Shanghai) cn-hongkong : China (Hong Kong) ap-southeast-1 : Singapore cn-hangzhou : China (Hangzhou)	cn-hangzhou
InstanceGroupName	string	No	The name of the instance group. Note The name must be no more than 30 characters long. It must start with a letter. It cannot start with `http://` or `https://`. It can contain only letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).	云手机A
NumberOfInstances	integer	No	The number of instances in the instance group. The maximum value is 100.	1
ChargeType	string	No	The billing method. Valid values: PostPaid : pay-as-you-go PrePaid : subscription	PostPaid
Period	integer	No	The subscription duration of the resource. The unit is specified by the `PeriodUnit` parameter.	1
PeriodUnit	string	No	The unit of the subscription duration. Valid values: Month : Month Year : Year Hour : Hour. This unit can only be used for the pay-as-you-go billing method.	Month
InstanceGroupSpec	string	Yes	The instance group specification. Call DescribeSpec to query the specifications available for purchase. Valid values: acp.perf.large : compute-optimized (8 vCPU, 16 GiB memory, 32 GiB storage) acp.basic.small : lightweight (2 vCPU, 4 GiB memory, 32 GiB storage) acp.std.large : standard (4 vCPU, 8 GiB memory, 32 GiB storage)	acp.basic.small
AutoPay	boolean	No	Specifies whether to enable automatic payment. The default value is false. Valid values: true : Enables automatic payment. Make sure your account has a sufficient balance. false : Enables manual payment.	false
AutoRenew	boolean	No	Specifies whether to enable auto-renewal. The default value is false. Valid values: true : The subscription resource is automatically renewed after it expires. false : The subscription resource must be manually renewed after it expires.	false
OfficeSiteId	string	No	The network ID. To create instances in a shared network: This parameter is optional. Enter the ID of a network of the Shared Network type from 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 instances in a VPC: This parameter is required. Enter the ID of a network of the VPC type from the Cloud Phone console > Network page. If no VPC exists in the console, create one first.	cn-hangzhou+dir-745976****
VSwitchId	string	No	The vSwitch ID. Call DescribeVSwitches to query the vSwitch list. For instances in a shared network: Leave this parameter empty. For instances in a VPC: This parameter is required. The instances are created in the specified vSwitch.	vsw-uf61uvzhz8ejaw776****
PolicyGroupId	string	No	The policy ID. Call ListPolicyGroups to query the policy list.	pg-b7bxrrwxkijjh****
ImageId	string	Yes	The image ID. Call DescribeImageList to query the image list for cloud phones.	imgc-06zyt9m93zwax****
Amount	integer	No	The number of instance groups. The default value is 1, and the maximum value is 100.	8
GpuAcceleration	boolean	No	Specifies whether to enable GPU acceleration. Valid values: true : Enabled false : Disabled [Default]	false
KeyPairId	string	No	The key pair ID. If you specify a valid key pair ID when creating the instance group, the key pair is attached to all successfully created instances. You do not need to call another API operation to attach the key pair. Note Attaching a key pair during a scale-out operation is not supported.	kp-7o9xywwfutc1l****
ClientToken	string	No	A client token to ensure the idempotence of the request. This prevents you from submitting duplicate requests. The token can be up to 100 characters long.	asadbuvwiabdbvchj****
EnableIpv6	boolean	No	Note This parameter is not yet available for public use.	null
Ipv6Bandwidth	integer	No	Note This parameter is not yet available for public use.	null
Tag	array<object>	No	The tags of the resource.
	object	No	The tag 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
BandwidthPackageType	string	No
BandwidthPackageId	string	No
NetworkType	string	No
PromotionId	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>	Information about the instance groups.
	object
InstanceGroupId	string	The instance group ID.	ag-cuv4scs4obxch****
InstanceIds	array	A list of instance IDs.
	string	The instance ID.	acp-g40b9at5nhjo9****
OrderId	string	The order ID.	22365781890****
InstanceGroupIds	array	A 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.