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

Usage notes

Before you call this operation, take note of the following limits:

  • You can add 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 a request ID, but the operation is still being performed in the system background. You can call the GetBasicIpSet operation to query the state of an acceleration region.
    • 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.
  • The CreateBasicIpSet operation cannot be repeatedly called for the same GA instance within a specific period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateBasicIpSet

The operation that you want to perform. Set the value to CreateBasicIpSet.

RegionId String Yes cn-hangzhou

The ID of the region where the basic GA instance is deployed. Set the value to cn-hangzhou.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. The client token can contain only ASCII characters.

Note If you do not set this parameter, the system sets ClientToken to the value of RequestId. The value of RequestId may be different for each API request.
AcceleratorId String Yes ga-bp17frjjh0udz4qz****

The ID of the basic GA instance.

AccelerateRegionId String Yes cn-shanghai

The ID of the acceleration region.

You can call the ListAvailableBusiRegions operation to query the acceleration regions available for a specified GA instance.

IspType String No BGP

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

If you are allowed to use single-ISP bandwidth, you can also specify one of the following values:

  • ChinaTelecom: China Telecom (single ISP)
  • ChinaUnicom: China Unicom (single ISP)
  • ChinaMobile: China Mobile (single ISP)
  • ChinaTelecom_L2: China Telecom _L2 (single ISP)
  • ChinaUnicom_L2: China Unicom _L2 (single ISP)
  • ChinaMobile_L2: China Mobile _L2 (single ISP)
Note The supported single-ISP type varies with the acceleration region.
Bandwidth Long No 2

The bandwidth allocated to the acceleration region. Unit: Mbit/s.

Response parameters

Parameter Type Example Description
RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

The ID of the request.

IpSetId String ips-bp11r5jb8ogp122xl****

The ID of the acceleration region of the basic GA instance.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateBasicIpSet
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&AcceleratorId=ga-bp17frjjh0udz4qz****
&AccelerateRegionId=cn-shanghai
&IspType=BGP
&Bandwidth=2
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateBasicIpSetResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <IpSetId>ips-bp11r5jb8ogp122xl****</IpSetId>
</CreateBasicIpSetResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 Resource.QuotaFull The resource quota is exceeded. The error message returned because 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 error message returned because 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 error message returned because 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. The error message returned because an error occurred while processing the request. Try again later. If the error persists, submit a ticket.

For a list of error codes, see Service error codes.