Creates one or more acceleration regions.

Usage notes

  • CreateIpSets 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 DescribeIpSet operation to query the status of acceleration regions.
    • 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.
  • The CreateIpSets operation cannot be called repeatedly for the same Global Accelerator (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 CreateIpSets

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

RegionId String Yes cn-hangzhou

The region ID of the GA instance. Set the value to cn-hangzhou.

ClientToken String No 1F4B6A4A-C89E-489E-BAF1-52777EE148EF

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-bp1yeeq8yfoyszmqy****

The ID of the GA instance.

AccelerateRegion.N.AccelerateRegionId String Yes cn-huhehaote

The ID of the region that requires acceleration.

The number of regions that can be added varies based on the specification of the GA instance. For more information, see Overview.

AccelerateRegion.N.IpVersion String No IPv6

The IP version used to connect to the GA instance. Valid values:

  • IPv4 (default): IPv4
  • IPv6: IPv6
AccelerateRegion.N.Bandwidth Integer No 2

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

Note
  • Each acceleration region must be allocated a minimum of 2 Mbit/s of bandwidth.
  • The total bandwidth for all acceleration regions cannot exceed the bandwidth limit of your basic bandwidth plan.
AccelerateRegion.N.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.

Response parameters

Parameter Type Example Description
RequestId String 1F4B6A4A-C89E-489E-BAF1-52777EE148EF

The ID of the request.

IpSets Array of GaIpSet

The details about the acceleration regions.

AccelerateRegionId String cn-qingdao

The ID of the region that requires acceleration.

Bandwidth Integer 2

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

IpSetId String ips-bp11r5jb8ogp122xl****

The ID of the acceleration region.

IspType String BGP

The line type of the EIP in the acceleration region.

AcceleratorId String ga-bp1yeeq8yfoyszmq****

The ID of the GA instance.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateIpSets
&RegionId=cn-hangzhou
&ClientToken=1F4B6A4A-C89E-489E-BAF1-52777EE148EF
&AcceleratorId=ga-bp1yeeq8yfoyszmqy****
&AccelerateRegion=[{"AccelerateRegionId":"cn-huhehaote","IpVersion":"IPv6","Bandwidth":2,"IspType":"BGP"}]
&Common request parameters

Sample success responses

XML format

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

<CreateIpSetsResponse>
    <RequestId>1F4B6A4A-C89E-489E-BAF1-52777EE148EF</RequestId>
    <IpSets>
        <AccelerateRegionId>cn-qingdao</AccelerateRegionId>
        <Bandwidth>2</Bandwidth>
        <IpSetId>ips-bp11r5jb8ogp122xl****</IpSetId>
        <IspType>BGP</IspType>
    </IpSets>
    <AcceleratorId>ga-bp1yeeq8yfoyszmq****</AcceleratorId>
</CreateIpSetsResponse>

JSON format

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

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

Error codes

HttpCode Error code Error message Description
400 Domain.NotFit The domain is not fit the rule The error message returned because the domain name does not have an ICP number.
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.