All Products
Search
Document Center

Global Accelerator:DeleteCustomRoutingEndpoints

Last Updated:Jan 10, 2024

Deletes endpoints from a custom routing listener.

Operation description

  • DeleteCustomRoutingEndpoints 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 to query the status of the task.

    • If an endpoint group is in the updating state, the endpoint is being deleted. In this case, you can perform only query operations.
    • If an endpoint group is in the active state and the endpoint cannot be found after you call the DescribeCustomRoutingEndpoint operation, the endpoint is deleted.
  • You cannot call the DeleteCustomRoutingEndpoints operation again on the same Global Accelerator (GA) instance before the previous task is completed.

Debugging

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

Debug

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:DeleteCustomRoutingEndpointsWrite
  • CustomRoutingEndpoint
    acs:ga:{#regionId}:{#accountId}:customroutingendpoint/{#CustomRoutingEndpointId}
    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 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
EndpointGroupIdstringYes

The ID of the endpoint group to which the endpoint that you want to delete belongs.

epg-bp1bpn0kn908w4nb****
EndpointIdsarrayYes

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.

stringYes

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 parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2023-04-20The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.