Cloud Load Balancer
- Release Notes and Announcements
- Product Introduction
- Product Comparison
- Purchase Guide
- CLB Resource Package
- Getting Started
- Operation Guide
- CLB Instance
- CLB Listener
- Real Server
- Health Check
- Certificate Management
- Log Management
- Monitoring and Alarm
- Cloud Access Management
- Practical Tutorial
- Obtaining Real Client IPs
- Ops Guide
- Troubleshooting
- API Documentation
- Instance APIs
- Listener APIs
- Backend Service APIs
- Target Group APIs
- Redirection APIs
- Other APIs
- Classic CLB APIs
- Making API Requests
- Load Balancing APIs
- CLB API 2017
- Making API Requests
- Request Structure
- Returned Results
- General APIs
- Classic CLB APIs
- APIs for CLB Instances
- APIs for Listeners
- CLB Real Server APIs
- APIs for Health Check
- FAQs
- Troubleshooting Health Check Issues
DocumentationCloud Load BalancerAPI DocumentationCLB API 2017Classic CLB APIsAPIs for Health CheckDescribeLBHealthStatus
DescribeLBHealthStatus
Last updated: 2024-12-19 17:19:35
API Description
This API is used to query the health check parameters for CLB instances.
Domain name for API calls:
lb.api.qcloud.comRequest Parameters
The list below contains only the API request parameters. Common parameters should be added when you call the API. For more information, see Common Request Parameters. The
Action field for this API is DescribeLBHealthStatus.Parameter | Required | Type | Description |
loadBalancerId | Yes | String | |
listenerId | No | String |
Response Parameters
Parameter | Type | Description |
code | Int | |
message | String | API-related module error message description. |
codeDesc | String | Error code. For a successful operation, "Success" is returned. For a failed operation, a message describing the failure is returned. |
data | Array | Returned array. |
Data structure of the
data array:Parameter | Type | Description |
ip | String | Private IP of the CVM. |
protocol | String | Protocol. |
port | Int | Port of the CVM. |
vport | Int | Listening port of the CLB instance. |
healthStatus | Int | Health check result. 1: healthy; 0: unhealthy. |
Example
Sample request
https://lb.api.qcloud.com/v2/index.php?Action=DescribeLBHealthStatus&loadBalancerId=lb-abcdefgh
Sample response
{"code":0,"message" : "","codeDesc": "Success","data":[{"ip":"10.2.3.0","protocol":"TCP","port":8001,"vport":8001,"healthStatus":0}]}
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No