StopLoadBalancerListener - Server Load Balancer - Alibaba Cloud Documentation Center

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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
slb:StopLoadBalancerListener	update	loadbalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}	slb:tag	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	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 .	cn-hangzhou
LoadBalancerId	string	Yes	The CLB instance ID.	lb-bp13jaf5qli5xmg******
ListenerPort	integer	Yes	The frontend port that is used by the CLB instance. Valid values: 1 to 65535.	80
ListenerProtocol	string	No	The frontend protocol that is used by the CLB instance. Note This parameter is required if the same port is used by listeners of different protocols.	https

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
400	TooManyListeners	More than 1 listener is found, please be more specified.
400	Operation.NotAllowed	The specified listener is not allowed to operate.

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