CreateIpSets - Global Accelerator - Alibaba Cloud Documentation Center

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, it indicates that the acceleration regions are being created. In this case, you can perform only query operations.
- If acceleration regions are in the active state, it indicates that the acceleration regions are created.
You cannot call the CreateIpSets operation again on the same GA instance before the previous operation is completed.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
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 that is 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	Yes	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 that you want 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 parameters

Parameter	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

Sample success responses

JSONformat

{
  "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	-
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.
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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-04-20	The Error code has changed	View Change Details
2023-04-06	The Error code has changed	View Change Details