All Products
Search

This Product

    Global Accelerator:DeleteListener

    Document Center

    Global Accelerator:DeleteListener

    Last Updated:Jul 31, 2024

    Deletes a listener.

    Operation description

    • Before you call the DeleteListener operation, make sure that no endpoint groups are associated with the listener that you want to delete. For information about how to delete an endpoint group, see the following topics:

      • DeleteEndpointGroup : deletes an endpoint group that is associated with an intelligent routing listener.
      • DeleteEndpointGroups : deletes multiple endpoint groups that are associated with intelligent routing listeners at the same time.
      • DeleteCustomRoutingEndpointGroups : deletes multiple endpoint groups that are associated with custom routing listeners at the same time.

    • DeleteListener 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 the DescribeListener operation to query the status of the listener.

      • If the listener is in the deleting state, the listener is being deleted. In this case, you can perform only query operations.
      • If the listener cannot be queried, the listener is deleted.

    • You cannot repeatedly call the DeleteListener operation to delete the listeners of the same Global Accelerator (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:DeleteListenerdelete
    • Listener
      acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}
      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 ID of the GA instance for which you want to delete a listener.

    		ga-bp1odcab8tmno0hdq****
    ListenerIdstringYes

    The ID of the listener that you want to delete.

    		lsr-bp1bpn0kn908w4nbw****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned information.

    RequestIdstring

    The ID of the request.

    		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.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.
    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