Delete a GWLB Listener and Track Removal Status via DeleteListener API - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Operation description

The DeleteListener operation is asynchronous. After you call this operation, the system returns a request ID, but the listener is not immediately deleted. The deletion task continues to run in the background. You can call GetListenerAttribute to query the deletion status of the listener:

If the listener is in the Deleting state, the listener is being deleted.
If the listener cannot be queried, the listener is deleted.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

gwlb:DeleteListener

delete

*LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

*Listener

acs:gwlb:{#regionId}:{#accountId}:listener/{#ListenerId}

None

Request parameters

Parameter	Type	Required	Description	Example
ListenerId	string	Yes	The ID of the listener.	lsn-brx2y3hqdincizg***
DryRun	boolean	No	Specifies whether to only precheck the request. Valid values: true: The system prechecks the request without deleting the listener. The precheck items include required parameters, request format, and service limits. If the request fails the precheck, the system returns the corresponding error. If the request passes the precheck, the system returns the `DryRunOperation` error code. false (default): The system sends a normal request. If the request passes the precheck, the system returns an HTTP 2xx status code and performs the operation.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can generate the parameter value on your client to ensure that it is unique across different requests. The client token supports only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is unique.	123e4567-e89b-12d3-a456-42665544****

Response elements

Element	Type	Description	Example
	object	The response of the request.
RequestId	string	The ID of the request.	5C6E3548-086F-5FF6-A2B3-B1871B3AB488

Examples

Success response

JSON format

{
  "RequestId": "5C6E3548-086F-5FF6-A2B3-B1871B3AB488"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.	Resource %s with business state %s does not support current operation
400	IncorrectStatus.Listener	The status of %s [%s] is incorrect.	Operation not supported for resource% s in current state% s.
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.	Resource %s current state %s does not support operation
404	ResourceNotFound.LoadBalancer	The specified resource of %s is not found.	The specified resource of .LoadBalancer is not found.
404	ResourceNotFound.Listener	The specified resource of %s is not found.	The specified resource of %s is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.