Use CreateIpSets to create acceleration regions - Global Accelerator - Alibaba Cloud - Global Accelerator

Creates acceleration regions.

Operation description

CreateIpSets is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the DescribeIpSet operation to query the status of the task.
- If acceleration regions are in the init state, the acceleration regions are being created. In this case, you can perform only query operations.
- If acceleration regions are in the active state, the acceleration regions are created.
You cannot call the CreateIpSets operation again on the same GA instance before the previous operation is completed.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ga:CreateIpSets

create

*IpSet

acs:ga:{#regionId}:{#accountId}:ipset/*

*Accelerator

acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}

ga:AcceleratorMainland

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the GA instance. Set the value to cn-hangzhou.	cn-hangzhou
ClientToken	string	No	The client token used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.	1F4B6A4A-C89E-489E-BAF1-52777EE148EF
AcceleratorId	string	Yes	The GA instance ID.	ga-bp1yeeq8yfoyszmqy****
AccelerateRegion	array<object>	Yes	The information about the acceleration regions.
	object	No	The information about the acceleration regions.
AccelerateRegionId	string	Yes	The ID of the acceleration region. The number of regions that you can add varies based on the specification of the GA instance. For more information, see Overview.	cn-huhehaote
IpVersion	string	No	The IP version used to connect to the GA instance. Valid values: IPv4 (default) IPv6 DUAL_STACK: IPv4 and IPv6 Note Only pay-as-you-go standard GA instances support DUAL_STACK.	IPv6
Bandwidth	integer	No	The bandwidth to allocate to the acceleration region. Unit: Mbit/s. Note This parameter is required. You must allocate at least 2 Mbit/s of bandwidth to each acceleration region. The total bandwidth of all acceleration regions cannot exceed the bandwidth limit of your basic bandwidth plan.	2
IspType	string	No	The line type of the elastic IP address (EIP) in the acceleration region. Valid values: BGP: BGP (Multi-ISP) lines. BGP_PRO: BGP (Multi-ISP) Pro lines Note This parameter is required only if the bandwidth metering method of the GA instance is pay-by-data transfer. Different acceleration regions support different line types of EIPs.	BGP

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1F4B6A4A-C89E-489E-BAF1-52777EE148EF
IpSets	array<object>	The details about the acceleration regions.
	object	The details about the acceleration regions.
AccelerateRegionId	string	The acceleration region ID.	cn-qingdao
Bandwidth	integer	The bandwidth allocated to the acceleration region. Unit: Mbit/s.	2
IpSetId	string	The acceleration region ID.	ips-bp11r5jb8ogp122xl****
IspType	string	The line type of the EIP in the acceleration region.	BGP
AcceleratorId	string	The GA instance ID.	ga-bp1yeeq8yfoyszmq****

Examples

Success response

JSON format

{
  "RequestId": "1F4B6A4A-C89E-489E-BAF1-52777EE148EF",
  "IpSets": [
    {
      "AccelerateRegionId": "cn-qingdao",
      "Bandwidth": 2,
      "IpSetId": "ips-bp11r5jb8ogp122xl****",
      "IspType": "BGP"
    }
  ],
  "AcceleratorId": "ga-bp1yeeq8yfoyszmq****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Domain.NotFit	The domain is not fit the rule	The domain name does not have an ICP number.
400	Resource.QuotaFull	The resource quota is exceeded.	The number of resources has reached the upper limit.
400	StateError.Accelerator	accelerator state %s is illegal	The GA instance is in an invalid state %s.
400	RegionRepeat.IpSet	An accelerator can only have one IpSet in one region. accelerator = %s, region = %s
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	An error occurred while the request was being processed. Try again later.
403	Forbbiden.SubUser	You are not authorized to operate on the specified resource because your account was created by another user.	The current account is a RAM user and does not have permissions to manage the specified resources.
403	Forbidden	The user is not authorized to operate on the specified resource.	The current account does not have permissions to manage the specified resources.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.