All Products
Search
Document Center

Server Load Balancer:SetListenerAccessControlStatus

Last Updated:Mar 14, 2024

Enables or disables the whitelist of a specified listener.

Debugging

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
slb:SetListenerAccessControlStatusWRITE
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

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
LoadBalancerIdstringYes

The ID of the CLB instance.

lb-8vb86hxixo8lvsja8****
ListenerPortintegerYes

The frontend port that is used by the CLB instance.

Valid values: 1 to 65535.

80
AccessControlStatusstringYes

Specifies whether to enable the whitelist. Valid values:

  • open_white_list: enables the whitelist.
  • close: disables the whitelist.
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
ListenerProtocolstringNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400TooManyListenersMore than 1 listener is found, please be more specified
400OperationFailed.ActionNotSupportThe loadbalancer of ipv6 does not support such action.
400OperationUnsupported.SetAccessControlThe singleTunnel/anyTunnel loadbalancer does not support config AccessControlList.

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