All Products
Search

This Product

    Global Accelerator:DeleteEndpointGroup

    Document Center

    Global Accelerator:DeleteEndpointGroup

    Last Updated:Jul 31, 2024

    Deletes an endpoint group.

    Operation description

    • DeleteEndpointGroup 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 DescribeEndpointGroup operation to query the status of the endpoint group.

      • If the endpoint group is in the deleting state, it indicates that the endpoint group is being deleted. In this case, you can perform only query operations.
      • If the endpoint group cannot be queried, it indicates that the endpoint group is deleted.

    • The DeleteEndpointGroup operation holds an exclusive lock on the Global Accelerator (GA) instance. While the operation is in progress, you cannot call the same operation in the same Alibaba Cloud account.

    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:DeleteEndpointGroupdelete
    • EndpointGroup
      acs:ga:{#regionId}:{#accountId}:endpointgroup/{#endpointGroupId}
      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
    AcceleratorIdstringNo

    The GA instance ID.

    		ga-bp1odcab8tmno0hdq****
    EndpointGroupIdstringYes

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

    		epg-bp1dmlohjjz4kqaun****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		6FEA0CF3-D3B9-43E5-A304-D217037876A8

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400Resource.QuotaFullThe resource quota is exceeded.The number of resources has reached the upper limit.
    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.ListenerThe listener does not exist.The listener does not exist.
    400NotActive.ListenerThe state of the listener is not active.The listener is unstable.
    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.
    400StateError.AcceleratorThe 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