Call DeleteBasicAccelerateIpEndpointRelation to disassociate an accelerated IP address from an endpoint - Global Accelerator - Alibaba Cloud - Global Accelerator

Operation description

DeleteBasicAccelerateIpEndpointRelation is an asynchronous operation. After a request is sent, the system returns a request ID, but the attach relationship between the accelerated IP address and the endpoint of the basic Global Accelerator (GA) instance is not immediately removed. The deletion task continues to run in the background. You can call the following operations to check whether the attach relationship between the accelerated IP address and the endpoint is deleted:
- Call GetBasicAccelerateIp or ListBasicEndpoints to query the status of the accelerated IP address and the endpoint respectively. If the status of the accelerated IP address and the endpoint is unbinding, the attach relationship is being deleted. In this state, you can only perform query operations and cannot perform other operations.
- Call ListBasicAccelerateIpEndpointRelations to query the attach status between the accelerated IP address and the endpoint. If no attach information is returned, the attach relationship between the accelerated IP address and the endpoint is deleted.
DeleteBasicAccelerateIpEndpointRelation does not support concurrent deletion of attach relationships between accelerated IP addresses and endpoints within the same basic GA instance.

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:DeleteBasicAccelerateIpEndpointRelation

delete

*BasicAccelerateIpEndpointRelation

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

*BasicAccelerateIpEndpointRelation

acs:ga:{#regionId}:{#accountId}:basicgaip/{#basicgaipId}

*BasicAccelerateIpEndpointRelation

acs:ga:{#regionId}:{#accountId}:basicendpoint/{#basicendpointId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Global Accelerator instance. Set the value to ap-southeast-1.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of a request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId value as the ClientToken value. The RequestId value is different for each API request.	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	Yes	The ID of the basic GA instance.	ga-bp17frjjh0udz4qz****
EndpointId	string	Yes	The endpoint ID of the basic GA instance. You can call ListBasicEndpoints to query the endpoint ID.	ep-bp14sz7ftcwwjgrdm****
AccelerateIpId	string	Yes	The accelerated IP address instance ID of the basic GA instance. You can call ListBasicAccelerateIps to query the accelerated IP address instance ID.	gaip-bp1****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
AcceleratorId	string	The ID of the basic GA instance.	ga-bp17frjjh0udz4qz****
EndpointId	string	The endpoint ID of the basic GA instance.	ep-bp14sz7ftcwwjgrdm****
AccelerateIpId	string	The accelerated IP address instance ID of the basic GA instance.	gaip-bp1****
State	string	The attach status between the accelerated IP address and the endpoint of the basic GA instance. Note This parameter is not currently in use.	null

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "AcceleratorId": "ga-bp17frjjh0udz4qz****",
  "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
  "AccelerateIpId": "gaip-bp1****",
  "State": "null"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.