Creates an accelerated IP address for a basic Global Accelerator (GA) instance.

Usage notes

  • CreateBasicAccelerateIp 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 GetBasicAccelerateIp operation to query the status of an accelerated IP address:
    • If no status information is returned, the accelerated IP address is being created. In this case, you can perform only query operations.
    • If the accelerated IP address is in the active state, the accelerated IP address is created.
  • The CreateBasicAccelerateIp 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 automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateBasicAccelerateIp

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

RegionId String Yes cn-hangzhou

The ID of the region where the 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 token can contain only ASCII characters.

Note If you do not specify this parameter, the system uses RequestId as ClientToken. RequestId may be different for each API request.
AcceleratorId String Yes ga-bp17frjjh0udz4qz****

The ID of the basic GA instance.

IpSetId String Yes ips-bp11r5jb8ogp122xl****

The ID of the acceleration region.

Response parameters

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

The ID of the request.

AcceleratorId String ga-bp17frjjh0udz4qz****

The ID of the basic GA instance.

IpSetId String ips-bp11r5jb8ogp122xl****

The ID of the acceleration region.

AccelerateIpId String gaip-bp1****

The ID of the accelerated IP address.

AccelerateIpAddress String 116.132.XX.XX

The accelerated IP address.

State String null

The status of the accelerated IP address.

Note This parameter returns an empty string because the parameter is not in use.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateBasicAccelerateIp
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&AcceleratorId=ga-bp17frjjh0udz4qz****
&IpSetId=ips-bp11r5jb8ogp122xl****
&Common request parameters

Sample success responses

XML format 

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

<CreateBasicAccelerateIpResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>
    <IpSetId>ips-bp11r5jb8ogp122xl****</IpSetId>
    <AccelerateIpId>gaip-bp1****</AccelerateIpId>
    <AccelerateIpAddress>116.132.XX.XX</AccelerateIpAddress>
    <State>null</State>
</CreateBasicAccelerateIpResponse>

JSON format 

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

{
  "RequestId" : "04F0F334-1335-436C-A1D7-6C044FE73368",
  "AcceleratorId" : "ga-bp17frjjh0udz4qz****",
  "IpSetId" : "ips-bp11r5jb8ogp122xl****",
  "AccelerateIpId" : "gaip-bp1****",
  "AccelerateIpAddress" : "116.132.XX.XX",
  "State" : "null"
}

Error codes

HttpCode Error code Error message Description
400 NotExist.Accelerator The accelerated instance does not exist. The error message returned because the specified GA instance does not exist.
400 StateError.Accelerator accelerator state configuring is illegal The error message returned because the specified GA instance is in an invalid state.
400 NotExist.IpSet The IpSet does not exist. The error message returned because the specified acceleration region does not exist.
400 NotActive.IpSet The state of IpSet is not active. The error message returned because the operation is not supported while the acceleration region is in the current state.

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