Enables or disables the whitelist of a specified listener.
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:
- 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:SetListenerAccessControlStatus | WRITE |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | No | The region where the Classic Load Balancer (CLB) instance is created. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
LoadBalancerId | string | Yes | The ID of the CLB instance. | lb-8vb86hxixo8lvsja8**** |
ListenerPort | integer | Yes | The frontend port that is used by the CLB instance. Valid values: 1 to 65535. | 80 |
AccessControlStatus | string | Yes | Specifies whether to enable the whitelist. Valid values:
Note
After the whitelist is enabled, if no IP address is added to the whitelist, the CLB instance does not distribute network traffic.
| open_white_list |
ListenerProtocol | string | No | The frontend protocol that is used by the CLB instance. Note
This parameter is required when listeners that use different protocols listen on the same port.
| https |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 | OperationFailed.ActionNotSupport | The loadbalancer of ipv6 does not support such action. |
400 | OperationUnsupported.SetAccessControl | The singleTunnel/anyTunnel loadbalancer does not support config AccessControlList. |
For a list of error codes, visit the Service error codes.