GetSpareIp - Global Accelerator - Alibaba Cloud Documentation Center

Queries the status of a secondary IP address that is associated with a CNAME.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ga:GetSpareIp	get	Accelerator acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the GA instance. Set the value to cn-hangzhou.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.	1F4B6A4A-C89E-489E-BAF1-52777EE148EF
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	true
AcceleratorId	string	Yes	The GA instance ID.	ga-bp1odcab8tmno0hdq****
SpareIp	string	Yes	The secondary IP address that is associated with the CNAME. If the acceleration area becomes unavailable, GA redirects traffic to the secondary IP address.	47.100.XX.XX

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
State	string	The status of the secondary IP address. Valid values: active: The secondary IP address is available. inuse: The secondary IP address is in use.	active

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	No permissions.	No permissions.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-07-23	The Error code has changed	View Change Details
2023-03-31	The internal configuration of the API is changed, but the call is not affected	View Change Details