Queries the health check status of a Gateway Load Balancer (GWLB) 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 |
---|---|---|---|---|
gwlb:GetListenerHealthStatus | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ListenerId | string | Yes | The listener ID. | lsn-7sixpvm5fc3v0b**** |
NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. Valid values:
| 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 be skipped in the call. | 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. You can filter by one or more filter condition names. Valid values:
| Status |
Values | array | No | The filter condition values. You can specify at most 20 condition values. | |
string | No | The filter condition value. The valid values vary based on the specified filter condition name in the response. | Unhealthy |
Response parameters
Examples
Sample success responses
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. |
For a list of error codes, visit the Service error codes.