All Products
Document Center

Server Load Balancer:StopLoadBalancerListener

Last Updated:Mar 14, 2024

Stops a listener.

Operation description

Before you make this API call, note the following:

  • After the API call is successfully made, the listener enters the stopped state.
  • If the Server Load Balancer (SLB) instance to which the listener to be stopped belongs is in the locked state, this API call cannot be made.
Note If you stop the listener, your services will be disrupted. Exercise caution when you perform this action.


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
  • loadbalancer
  • slb:tag

Request parameters


The ID of the region to which the SLB instance belongs.

To query the region ID, refer to the list of regions and zones or call DescribeRegions .


The ID of the SLB instance to which the listener belongs.


The frontend listening port used by the listener.

Value range: 1 to 65535


The frontend listening protocol used by the SLB instance.

Note This parameter is required when listeners with different protocols use the same port.

Response parameters


The ID of the request.



Sample success responses


  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"

Error codes

HTTP status codeError codeError message
400TooManyListenersMore than 1 listener is found, please be more specified.
400Operation.NotAllowedThe specified listener is not allowed to operate.

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