All Products
Search
Document Center

Global Accelerator:DeleteBasicEndpointGroup

Last Updated:May 16, 2024

Deletes an endpoint group that is associated with a basic Global Accelerator (GA) instance.

Operation description

Before you delete an endpoint group, take note of the following items:

  • If an endpoint in the endpoint group is associated with an accelerated IP address, you cannot delete the endpoint group. You can call the DeleteBasicAccelerateIpEndpointRelation operation to disassociate the endpoint from the accelerated IP address.

  • If no endpoint in the endpoint group is associated with an accelerated IP address, you can delete the endpoint group. When you delete an endpoint group, all endpoints in the endpoint group are deleted.

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

    • If the endpoint group is in the deleting state, the endpoint group is being deleted. In this case, you can perform only query operations.
    • If the endpoint group cannot be queried, the endpoint group is deleted.
  • The DeleteBasicEndpointGroup operation cannot be repeatedly called for the same GA instance within a specific period of time.

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:DeleteBasicEndpointGroupWrite
  • BasicEndpointGroup
    acs:ga:{#regionId}:{#accountId}:endpointgroup/{#BasicEndpointGroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
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
EndpointGroupIdstringYes

The ID of the endpoint group that is associated with the basic GA instance.

epg-bp1dmlohjjz4kqaun****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

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.EndPointGroupThe endpoint group does not exist.The endpoint group does not exist.
400StateError.EndPointGroupThe specified state of endpoint group is invalid.The endpoint group is in an invalid state.
400NotExist.AcceleratorThe accelerated instance does not exist.The GA instance does not exist.
400StateError.AcceleratorThe state of the accelerated instance is invalid.The status of the GA instance is invalid.
403Forbbiden.SubUserYou are not authorized to operate on the specified resource because your account was created by another user.The current account is a RAM user and does not have permissions to manage the specified resources.
403ForbiddenThe user is not authorized to operate on the specified resource.The current account does not have permissions to manage the specified resources.
500UnknownErrorAn error occurred while processing your request. Please try again. If the error persists, please submit a ticket.An error occurred while the request was being processed. Try again later.

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

Change history

Change timeSummary of changesOperation
No change history