Use DeleteCustomRoutingEndpointGroupDestinations to delete endpoint group mappings for a custom routing listener - Global Accelerator - Alibaba Cloud - Global Accelerator

Operation description

DeleteCustomRoutingEndpointGroupDestinations 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 DescribeCustomRoutingEndpointGroup operation to query the status of the task.
- If the endpoint group is in the updating state, mappings are being deleted from the endpoint group. In this case, you can perform only query operations.
- If the endpoint group is in the active state and the mappings you want to delete are no longer found in the response of the DescribeCustomRoutingEndpointGroupDestinations operation, the mappings have been deleted from the endpoint group.
You cannot call the DeleteCustomRoutingEndpointGroupDestinations operation on the same Global Accelerator (GA) instance before the previous request is completed.

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

delete

*CustomRoutingEndpointGroupDestination

acs:ga:{#regionId}:{#accountId}:customroutingendpointgroup/{#EndpointGroupId}

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 ensure that the token is unique among all 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.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Specifies whether to perform a dry run without performing the actual request. Valid values: true: performs 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: 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.	false
EndpointGroupId	string	Yes	The endpoint group ID. **	epg-bp1dmlohjjz4kqaun****
DestinationIds	array	No	The IDs of the endpoint group mappings.
	string	No	The ID of the endpoint group mapping. If this parameter is left empty, all mappings are deleted from the endpoint group specified by EndpointGroupId. You can specify at most 100 endpoint group mapping IDs.	dst-abc123****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotExist.EndPointGroup	endpoint group %s is not exist	The endpoint group %s does not exist.
400	StateError.EndPointGroup	endpoint group state %s is illegal	The endpoint group is in an invalid state.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.