All Products
Search
Document Center

Global Accelerator:DeleteCustomRoutingEndpointGroups

Last Updated:Jul 31, 2024

Deletes multiple endpoint groups that are associated with a custom routing listener.

Operation description

  • DeleteCustomRoutingEndpointGroups is an asynchronous operation. After you send a request, the system returns a request ID, but the operation is still being performed in the system background. You can call the DescribeCustomRoutingEndpointGroup operation to query the state of the endpoint groups associated with a custom routing listener that you attempt to delete.

    • If the endpoint groups are in the deleting state, the endpoint groups are being deleted. In this case, you can perform only query operations.
    • If the endpoint groups cannot be queried, the endpoint groups are deleted.
  • You cannot use the DeleteCustomRoutingEndpointGroups operation on the same Global Accelerator (GA) instance before the previous operation is complete.

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:DeleteCustomRoutingEndpointGroupsdelete
  • CustomRoutingEndpointGroup
    acs:ga:{#regionId}:{#accountId}:customroutingendpointgroup/{#EndpointGroupId}
  • CustomRoutingEndpointGroup
    acs:ga:{#regionId}:{#accountId}:customroutingendpointgroup/{#EndpointGroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the GA instance is deployed. 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.
123e4567-e89b-12d3-a456-426655440000
DryRunbooleanNo

Specifies whether to perform a dry run. Valid values:

  • true: performs a dry run. The system checks the required parameters, request syntax, and 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 sends the request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
false
AcceleratorIdstringNo

The ID of the GA instance that you want to query.

ga-bp1odcab8tmno0hdq****
EndpointGroupIdsarrayYes

The IDs of the endpoint groups that you want to delete.

You can specify up to 10 endpoint group IDs.

stringYes

The IDs of the endpoint groups that you want to delete.

You can specify up to 10 endpoint group IDs.

epg-bp1dmlohjjz4kqaua****

Response parameters

ParameterTypeDescriptionExample
object

The returned information.

RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400NotExist.EndPointGroupendpoint group %s is not existThe endpoint group %s does not exist.
400StateError.EndPointGroupendpoint group state %s is illegalThe endpoint group is in an invalid state.

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

Change history

Change timeSummary of changesOperation
2024-07-23The Error code has changedView Change Details
2023-04-20The internal configuration of the API is changed, but the call is not affectedView Change Details