All Products
Search

This Product

    Global Accelerator:DeleteSpareIps

    Document Center

    Global Accelerator:DeleteSpareIps

    Last Updated:Jul 31, 2024

    Deletes the secondary IP addresses that are associated with a CNAME.

    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. You can call the DescribeAccelerator operation to query the status of a GA instance.

      • If the GA instance is in the configuring state, it indicates that the secondary IP addresses for the CNAME are being deleted. In this case, you can perform only query operations.
      • If the GA instance is in the active state and the secondary IP addresses for the CNAME cannot be queried by calling the ListSpareIps operation, it indicates that the IP addresses are deleted.

    • The DeleteSpareIps operation holds an exclusive lock on the GA instance. While the operation is in progress, you cannot call the same operation in the same Alibaba Cloud account.

    Debugging

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

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    ga:DeleteSpareIpsdelete
    • Accelerator
      acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the GA instance. Set the value to cn-hangzhou.

    		cn-hangzhou
    ClientTokenstringNo

    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.

    Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    		1F4B6A4A-C89E-489E-BAF1-52777EE148EF
    DryRunbooleanNo

    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • 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 (defalut): 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
    AcceleratorIdstringYes

    The GA instance ID.

    		ga-bp1odcab8tmno0hdq****
    SpareIpsarrayYes

    The secondary IP addresses to be deleted for the CNAME. If an acceleration area of the GA instance becomes unavailable, GA redirects the access traffic to the secondary IP addresses.

    Separate the IP addresses with commas (,). You can specify up to two secondary IP addresses.

    stringYes

    The secondary IP addresses to be deleted for the CNAME. If an acceleration area of the GA instance becomes unavailable, GA redirects the access traffic to the secondary IP addresses.

    Separate the IP addresses with commas (,). You can specify up to two secondary IP addresses.

    		127.0.XX.XX

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		6FEA0CF3-D3B9-43E5-A304-D217037876A8

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError message
    400NotExist.SpareIpThe spare ip %s doesn't exist.

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

    Change history

    Change timeSummary of changesOperation
    No change history