DeleteSpareIps - Delete CNAME secondary IPs | GA API - Global Accelerator

Operation description

DeleteSpareIps is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. Call the DescribeAccelerator operation to query the GA instance status.
- If the GA instance is in the configuring state, the CNAME secondary IP addresses are being deleted. Only query operations can be performed.
- If the GA instance is in the active state and the ListSpareIps operation does not return the secondary IP addresses, the deletion is complete.
DeleteSpareIps holds an exclusive lock on the GA instance. You cannot call this operation again in the same Alibaba Cloud account while it is running.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ga:DeleteSpareIps

delete

*Accelerator

acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}

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 ensures the idempotence of the request. You can use the client to generate the token. The token must be unique across requests and can contain only ASCII characters. Note If you do not specify this parameter, the system uses the request ID as the client token. The request ID may differ for each request.	1F4B6A4A-C89E-489E-BAF1-52777EE148EF
DryRun	boolean	No	Specifies whether to perform a dry run without executing the request. Valid values: true: performs a dry run only. 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 executes the 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****
SpareIps	array	Yes	The CNAME secondary IP addresses to delete. GA redirects traffic to these addresses when an acceleration area becomes unavailable. You can specify up to two IP addresses, separated by commas (,).
	string	No	The CNAME secondary IP addresses to delete. GA redirects traffic to these addresses when an acceleration area becomes unavailable. You can specify up to two IP addresses, separated by commas (,).	127.0.XX.XX

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	6FEA0CF3-D3B9-43E5-A304-D217037876A8

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	NotExist.SpareIp	The spare ip %s doesn't exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.