Retrieve GWLB Listener Attributes with GetListenerAttribute - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Queries the listener details of a load balancing instance.

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

gwlb:GetListenerAttribute

get

*LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadbalancerId}

*Listener

acs:gwlb:{#regionId}:{#accountId}:listener/{#ListenerId}

None

Request parameters

Parameter	Type	Required	Description	Example
ListenerId	string	Yes	The listener ID.	lsn-brx2y3hqdinciz****

Response elements

Element	Type	Description	Example
	object	The return values of the request.
ListenerDescription	string	The custom description of the listener. The description must be 2 to 256 characters in length, and can contain Chinese characters, English letters, digits, commas (,), periods (.), forward slashes (/), at signs (@), underscores (_), and hyphens (-).	listener_description
ListenerId	string	The listener ID.	lsn-3kbj3587mqhm3p****
ListenerStatus	string	The status of the listener. Valid values: Provisioning: The listener is being created. Running: The listener is running. Configuring: The listener is being configured. Deleting: The listener is being deleted.	Provisioning
LoadBalancerId	string	The instance ID of the Gateway Load Balancer (GWLB) that provides load balancing services.	gwlb-te609d6696632f76****
RegionId	string	The region ID of the Gateway Load Balancer (GWLB) instance that provides load balancing services.	cn-hangzhou
RequestId	string	The request ID.	75CC3312-7757-5EE1-90D8-49CEA66608AE
ServerGroupId	string	The ID of the server group.	sgp-sp8d2r6y7t0xtl****
TcpIdleTimeout	integer	The idle timeout period for TCP connections.	350
Tags	array<object>	The list of tags.
	object	The tag.
Key	string	The tag key. The tag key cannot be an empty string. It can be up to 128 characters in length, and cannot start with `aliyun` or `acs:`, or contain `http://` or `https://`.	testKey
Value	string	The tag value. It can be up to 256 characters in length, and cannot contain `http://` or `https://`.	testValue

Examples

Success response

JSON format

{
  "ListenerDescription": "listener_description",
  "ListenerId": "lsn-3kbj3587mqhm3p****",
  "ListenerStatus": "Provisioning",
  "LoadBalancerId": "gwlb-te609d6696632f76****",
  "RegionId": "cn-hangzhou",
  "RequestId": "75CC3312-7757-5EE1-90D8-49CEA66608AE",
  "ServerGroupId": "sgp-sp8d2r6y7t0xtl****",
  "TcpIdleTimeout": 350,
  "Tags": [
    {
      "Key": "testKey",
      "Value": "testValue"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
404	ResourceNotFound.Listener	The specified resource of %s is not found.	The specified resource of %s is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.