Queries the status of a spare IP address that is associated with the domain name to which a CNAME record points.

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 GetSpareIp

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

RegionId String Yes cn-hangzhou

The ID of the region where the Global Accelerator (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, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.

DryRun Boolean No true

Specifies whether only to precheck the request. Valid values:

  • true: prechecks the request without creating resources. The system checks the required parameters, request format, and service limits. If the precheck fails, an error message is returned. If the precheck is successful, the error code DryRunOperation is returned.
  • false: sends the request. If the precheck is successful, a 2xx HTTP status code is returned and the operation is performed. Default value: false.
AcceleratorId String Yes ga-bp1odcab8tmno0hdq****

The ID of the GA instance.

SpareIp String Yes 127.0.xx.xx

The spare IP address that is associated with the domain name to which the CNAME record points. When an error occurs in the acceleration area, traffic is routed to the spare IP address.

Response parameters

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

The ID of the request.

State String active

The status of the spare IP address. The spare IP address is associated with the domain name to which the CNAME record points.

  • active: The IP address is available.
  • inuse: The IP address is in use.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetSpareIp
&RegionId=cn-hangzhou
&ClientToken=1F4B6A4A-C89E-489E-BAF1-52777EE148EF
&DryRun=true
&AcceleratorId=ga-bp1odcab8tmno0hdq****
&SpareIp=127.0.xx.xx
&<Common request parameters>

Sample success responses

XML format 

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

<GetSpareIpResponse>
    <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>
    <State>active</State>
</GetSpareIpResponse>

JSON format 

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

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

Error codes

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