CreateBasicIpSet - Global Accelerator - Alibaba Cloud Documentation Center

Creates an acceleration region for a basic Global Accelerator (GA) instance.

Operation description

Take note of the following limits:

You can specify only one acceleration region for each basic GA instance, and only IPv4 clients can connect to basic GA instances.
CreateBasicIpSet is an asynchronous operation. After you send a request, the system returns an acceleration region ID and runs the task in the background. You can call the GetBasicIpSet operation to query the status of the task.
- If the acceleration region is in the init state, the acceleration region is being created. In this case, you can perform only query operations.
- If the acceleration region is in the active state, the acceleration region is created.
You cannot call the CreateBasicIpSet operation again on the same GA instance before the previous task 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:CreateBasicIpSet	create	BasicAccelerator acs:ga:{#regionId}:{#accountId}:ga/{#BasicAcceleratorId} BasicIpSet acs:ga:{#regionId}:{#accountId}:ipset/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the basic 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.	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	Yes	The ID of the basic GA instance.	ga-bp17frjjh0udz4qz****
AccelerateRegionId	string	Yes	The ID of the acceleration region. You can call the ListAvailableBusiRegions operation to query the most recent acceleration region list.	cn-shanghai
IspType	string	No	The line type of the elastic IP address (EIP) in the acceleration region. Valid values: BGP (default): BGP (Multi-ISP) lines. BGP_PRO: BGP (Multi-ISP) Pro lines. Valid values if you are allowed to use single-ISP bandwidth: ChinaTelecom ChinaUnicom ChinaMobile ChinaTelecom_L2 ChinaUnicom_L2 ChinaMobile_L2 Note If the bandwidth metering method of the GA instance is pay-by-data-transfer, this parameter is required. If the acceleration region is China (Hong Kong) and a basic bandwidth plan whose bandwidth type is Premium is associated with the GA instance, the default value of IspType is BGP_PRO. The supported single-ISP type varies based on the acceleration region.	BGP
Bandwidth	long	No	The bandwidth that you want to allocate to the acceleration region. Unit: Mbit/s. You must allocate at least 2 Mbit/s of bandwidth to the acceleration region.	2

Response parameters

Parameter	Type	Description	Example
	object	The response parameters
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
IpSetId	string	The region ID of the GA instance.	ips-bp11r5jb8ogp122xl****

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "IpSetId": "ips-bp11r5jb8ogp122xl****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Resource.QuotaFull	The resource quota is exceeded.	The number of resources has reached the upper limit.
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