Use CreateBasicIpSet to create an acceleration region for a basic instance - Global Accelerator - Alibaba Cloud - Global Accelerator

Operation description

When you invoke this operation, take note of the following items:

A basic Alibaba Cloud Global Accelerator (GA) instance supports only one acceleration region and supports only the IPv4 protocol.
CreateBasicIpSet is an asynchronous operation. After a request is sent, the system returns an acceleration region instance ID but the acceleration region is not yet created. The creation node continues to run in the background. You can invoke GetBasicIpSet to query the status of the acceleration region:
- If the acceleration region is in the init state, the acceleration region is being created. In this state, you can only execute query operations.
- If the acceleration region is in the active state, the acceleration region is created.
The CreateBasicIpSet operation does not support concurrent creation of acceleration regions within the same basic Alibaba Cloud Global Accelerator (GA) instance.

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:CreateBasicIpSet

create

*BasicAccelerator

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

*BasicIpSet

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the basic Alibaba Cloud Global Accelerator (GA) instance. Set the value to ap-southeast-1.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of a request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	Yes	The instance ID of the basic Alibaba Cloud Global Accelerator (GA) instance.	ga-bp17frjjh0udz4qz****
AccelerateRegionId	string	Yes	The ID of the region to be accelerated. You can invoke the ListAvailableBusiRegions operation to query the active acceleration regions for the specified Alibaba Cloud Global Accelerator (GA) instance.	cn-shanghai
IspType	string	No	The ISP type of the public network in the acceleration region. Valid values: BGP (default): BGP (Multi-ISP) BGP_PRO: BGP (Multi-ISP) Pro If you are a whitelist user of single-ISP bandwidth, you can also select the following types: ChinaTelecom: China Telecom (single ISP) ChinaUnicom: China Unicom (single ISP) ChinaMobile: China Shift (single ISP) ChinaTelecom_L2: China Telecom (single ISP)_L2 ChinaUnicom_L2: China Unicom (single ISP)_L2 ChinaMobile_L2: China Shift (single ISP)_L2 Note This parameter is required for basic Alibaba Cloud Global Accelerator (GA) instances that use the pay-by-traffic billing method. If the acceleration region of the basic Alibaba Cloud Global Accelerator (GA) instance is Hong Kong (China) and the instance is attached with a basic bandwidth plan of the BGP (Multi-ISP) Pro type, the default value is BGP (Multi-ISP) Pro. The supported single-ISP line types vary by acceleration region.	BGP
Bandwidth	integer	No	The bandwidth of the acceleration area. Unit: Mbps. The minimum bandwidth that can be allocated to an acceleration area is 2 Mbps.	2

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
IpSetId	string	The acceleration region instance ID of the basic Alibaba Cloud Global Accelerator (GA) instance.	ips-bp11r5jb8ogp122xl****

Examples

Success response

JSON format

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