Delete endpoints from a custom routing listener using DeleteCustomRoutingEndpoints - Global Accelerator - Alibaba Cloud - Global Accelerator

Operation description

DeleteCustomRoutingEndpoints is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call DescribeCustomRoutingEndpointGroup to query the task status.
- If the endpoint group is in the updating state, the endpoint is being deleted. You can perform only query operations.
- If the endpoint group is in the active state and the endpoint cannot be found after you call DescribeCustomRoutingEndpoint, the endpoint is deleted.
You cannot call DeleteCustomRoutingEndpoints again on the same Global Accelerator (GA) instance until the previous task 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:DeleteCustomRoutingEndpoints

delete

*CustomRoutingEndpoint

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

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 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
EndpointGroupId	string	Yes	The ID of the endpoint group that contains the endpoints to delete.	epg-bp1bpn0kn908w4nb****
EndpointIds	array	Yes	The IDs of endpoints to be deleted. If you do not set this parameter, all the endpoints in the specified endpoint group are deleted. You can specify at most 10 endpoint IDs.
	string	Yes	The IDs of endpoints to be deleted. If you do not set this parameter, all the endpoints in the specified endpoint group are deleted. You can specify at most 10 endpoint IDs.	ep-bp1dmlohjjz4kqaun****

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.
400	NotExist.Listener	listener %s is not exist	The listener %s does not exist.
400	NotActive.Listener	listener %s is not active	The listener %s is unavailable.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.