Call DescribeListenerAccessControlAttribute to query listener whitelist configurations - Server Load Balancer

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

slb:DescribeListenerAccessControlAttribute

get

*loadbalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

slb:tag
slb:tag
slb:tag

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region where the Classic Load Balancer (CLB) instance is created. You can query the region ID from the Regions and zones list or by calling the DescribeRegions operation.	cn-hangzhou
LoadBalancerId	string	Yes	The CLB instance ID.	lb-8vb86hxixo8lvsja8****
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 specified for listeners of different protocols.	https

Response elements

Element	Type	Description	Example
	object
SourceItems	string	The queried ACLs.	192.168.XX.XX
AccessControlStatus	string	Indicates whether the whitelist is enabled. Valid values: open_white_list: the whitelist is enabled. close: the whitelist is disabled.	open_white_list
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF34B540710

Examples

Success response

JSON format

{
  "SourceItems": "192.168.XX.XX",
  "AccessControlStatus": "open_white_list",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710"
}

Error codes

HTTP status code	Error code	Error message	Description
400	TooManyListeners	More than 1 listener is found, please be more specified

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.