Elastic Compute Service (ECS)
Container Compute Service (ACS)
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 Classic Load Balancer (CLB) instance to which the listener to be stopped belongs is in the locked state, this API call cannot be made.
If you stop the listener, your services will be disrupted. Exercise caution when you perform this action.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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 |
|---|
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| slb:StopLoadBalancerListener | update | *loadbalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | No | The region ID of the Classic Load Balancer (CLB) instance. 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.
This parameter is required if the same port is used by listeners of different protocols.
| https |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}Error codes
| HTTP status code | Error code | Error message |
|---|
| 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.
Change history
| Change time | Summary of changes | Operation |
|---|
| Change time | Summary of changes | Operation |
|---|
No change history
