Creates spare IP addresses for a canonical name (CNAME) that is assigned to a Global Accelerator (GA) instance. If the acceleration service within the acceleration area of your GA instance becomes unavailable, GA redirects the access traffic to the spare IP addresses.

Debugging

OpenAPIxplorer 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 CreateSpareIps

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

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 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. Make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

DryRun Boolean No true

Specifies whether only to precheck the request. Valid values:

  • true: only prechecks the request. If this value is used, the system does not create spare IP addresses after the request passes the precheck. The system checks the required parameters, request format, and service limits. If the request fails the precheck, the system returns an error code based on the cause of the failure. If the request passes the precheck, the system returns the DryRunOperation error code.
  • false: prechecks the request and then sends the request if the request passes the precheck. This value is the default value. After the request passes the precheck, the system returns a 2XX HTTP status code and creates spare IP addresses.
AcceleratorId String Yes ga-bp1odcab8tmno0hdq****

The ID of the GA instance.

SpareIps.N String Yes ['127.0.XX.XX', '139.0.XX.XX']

The spare IP addresses to be created for the CNAME. If the acceleration service within the acceleration area of the GA instance becomes unavailable, GA redirects the access traffic to the spare IP addresses.

Separate IP addresses with commas (,). Valid values of N: 0 to 2.

Response parameters

Parameter Type Example Description
RequestId String 6FEA0CF3-D3B9-43E5-A304-D217037876A8

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateSpareIps
&RegionId=cn-hangzhou
&ClientToken=1F4B6A4A-C89E-489E-BAF1-52777EE148EF
&DryRun=true
&AcceleratorId=ga-bp1odcab8tmno0hdq****
&SpareIps=["['127.0.XX.XX', '139.0.XX.XX']"]  
&<Common request parameters>

Sample success responses

XML format

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

<CreateSpareIpsResponse>
    <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>
</CreateSpareIpsResponse>

JSON format

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

{
  "RequestId" : "6FEA0CF3-D3B9-43E5-A304-D217037876A8"
}

Error codes

For a list of error codes, visit the API Error Center.