Monitor GWLB Listener Health in Real Time via API - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Queries the health check status of a Gateway Load Balancer (GWLB) listener.

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:GetListenerHealthStatus

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-7sixpvm5fc3v0b****
NextToken	string	No	The pagination token used to retrieve a new page of results. Valid values: If NextToken is empty, no next page exists. If a value of NextToken is returned, the value indicates the token that is used for the next query.	4f1d7cc9f51e18904e8a063603a6b0c3d03bc69f78734254e0b5e8707e68****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 1000. Default value: 20.	20
Skip	integer	No	The number of entries to skip.	10
Filter	array<object>	No	The filter conditions. You can specify at most 20 filter conditions.
	object	No	The filter condition.
Name	string	No	The filter condition name. Valid values: Status: the health status. ReasonCode: the cause of an unhealthy server. ServerId: the ID of the backend server. ServerIp: the IP address of the backend server.	Status
Values	array	No	The filter condition values. You can specify at most 20 condition values.
	string	No	The filter condition value. Valid values vary based on the filter condition name.	Unhealthy

Response elements

Element	Type	Description	Example
	object	The response parameters.
ListenerHealthStatus	array<object>	The health check status of server groups associated with the listener.
	array<object>	The health check status of server groups associated with the listener.
ListenerId	string	The listener ID.	lsn-sg8aha6pzjavvo****
ServerGroupInfos	array<object>	The information about the server groups.
	array<object>	The information about the server group.
HealthCheckEnabled	boolean	Indicates whether the health check feature is enabled. Valid values: true false	true
ServerGroupId	string	The server group ID.	sgp-0vdsbyszro3nr6****
Servers	array<object>	The backend servers.
	array<object>	The backend server.
Port	integer	The backend port.	6081
Reason	object	The reason why Status indicates an unhealthy status.
ReasonCode	string	The reason why Status indicates an unhealthy status. Valid values: CONNECT_TIMEOUT: GWLB failed to connect to the backend server within the specified period. CONNECT_FAILED: GWLB failed to connect to the backend server. RECV_RESPONSE_TIMEOUT: GWLB failed to receive a response from the backend server within the specified period. CONNECT_INTERRUPT: The connection between the health check and the backend server was interrupted. HTTP_CODE_NOT_MATCH: The HTTP status code from the backend server did not match the expected value. HTTP_INVALID_HEADER: The format of the response from the backend servers is invalid.	CONNECT_TIMEOUT
ServerId	string	The backend server ID.	i-2ze4rnh8yj9kif3z****
ServerIp	string	The IP address of the server.	192.168.0.XXX
Status	string	The health status of the backend server. Valid values: Initial: Health checks are configured for the GWLB instance, but no data is found. Unhealthy: The backend server consecutively fails health checks. Unused: The backend server is not in use. Unavailable: Health checks are disabled. Healthy: The backend server is healthy.	Healthy
MaxResults	integer	The number of entries per page. Valid values: 1 to 1000. Default value: 20.	20
NextToken	string	A pagination token used to retrieve a new page of results. Valid values: If NextToken is empty, no next page exists. If a value of NextToken is returned, the value indicates the token that is used for the next query.	U12WEI6Ro2ol3wA54rBNSwdC5+lYy6q5SjIQEvc1wz5mjZxV+YjsHRdXV8XauY1BpOQIvwX63E0en54H3D****
RequestId	string	The request ID.	0ED4F222-36A0-5470-8A9A-AAB4E96BAC1A
TotalCount	integer	The total number of entries returned.	31

Examples

Success response

JSON format

{
  "ListenerHealthStatus": [
    {
      "ListenerId": "lsn-sg8aha6pzjavvo****",
      "ServerGroupInfos": [
        {
          "HealthCheckEnabled": true,
          "ServerGroupId": "sgp-0vdsbyszro3nr6****",
          "Servers": [
            {
              "Port": 6081,
              "Reason": {
                "ReasonCode": "CONNECT_TIMEOUT"
              },
              "ServerId": "i-2ze4rnh8yj9kif3z****",
              "ServerIp": "192.168.0.XXX",
              "Status": "Healthy"
            }
          ]
        }
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "U12WEI6Ro2ol3wA54rBNSwdC5+lYy6q5SjIQEvc1wz5mjZxV+YjsHRdXV8XauY1BpOQIvwX63E0en54H3D****",
  "RequestId": "0ED4F222-36A0-5470-8A9A-AAB4E96BAC1A",
  "TotalCount": 31
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.FilterValue	The param of %s is illegal.	The parameter of FilterValue is illegal.
400	IllegalParam.FilterName	The param of %s is illegal.	The parameter of FilterName is illegal.
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.