有奖捉虫:云通信与企业服务文档专题,速来> HOT
文档中心 > API 中心 > 负载均衡 > 后端服务相关接口 > 获取负载均衡后端服务的健康检查状态

1. 接口描述

接口请求域名: clb.tencentcloudapi.com 。

DescribeTargetHealth 接口用来获取负载均衡后端服务的健康检查结果,不支持传统型负载均衡。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTargetHealth。
Version String 公共参数,本接口取值:2018-03-17。
Region String 公共参数,详见产品支持的 地域列表
LoadBalancerIds.N Array of String 要查询的负载均衡实例ID列表。
示例值:["lb-qc2iq5yc\n"]

3. 输出参数

参数名称 类型 描述
LoadBalancers Array of LoadBalancerHealth 负载均衡实例列表。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询负载均衡实例的后端健康状态

输入示例

POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTargetHealth
<公共请求参数>

{
    "LoadBalancerIds": [
        "lb-qc2iq5yc"
    ]
}

输出示例

{
    "Response": {
        "LoadBalancers": [
            {
                "Listeners": [
                    {
                        "Rules": [
                            {
                                "Url": "/",
                                "Domain": "www.123.com",
                                "LocationId": "loc-5t7526km",
                                "Targets": []
                            }
                        ],
                        "Port": 666,
                        "Protocol": "HTTP",
                        "ListenerId": "lbl-j36caqde",
                        "ListenerName": "http-111"
                    },
                    {
                        "Rules": [
                            {
                                "Url": null,
                                "Domain": null,
                                "LocationId": "loc-ewygg6i0",
                                "Targets": [
                                    {
                                        "HealthStatus": false,
                                        "IP": "172.16.0.6",
                                        "TargetId": "ins-19425500",
                                        "Port": 2020
                                    },
                                    {
                                        "HealthStatus": true,
                                        "IP": "172.16.0.12",
                                        "TargetId": "ins-19425y2y",
                                        "Port": 80
                                    }
                                ]
                            }
                        ],
                        "Port": 789,
                        "Protocol": "TCP",
                        "ListenerId": "lbl-fs9naq76",
                        "ListenerName": "tcp_test"
                    },
                    {
                        "Rules": [
                            {
                                "Url": "/",
                                "Domain": "www.456.com",
                                "LocationId": "loc-8gdc4qcq",
                                "Targets": []
                            }
                        ],
                        "Port": 777,
                        "Protocol": "HTTP",
                        "ListenerId": "lbl-9nj07x0m",
                        "ListenerName": "http-222"
                    },
                    {
                        "Rules": [],
                        "Port": 1949,
                        "Protocol": "HTTPS",
                        "ListenerId": "lbl-087wrv48",
                        "ListenerName": "https-000"
                    }
                ],
                "LoadBalancerName": "lb-test123",
                "LoadBalancerId": "lb-qc2iq5yc"
            }
        ],
        "RequestId": "9d45e1ec-720c-4ce1-860e-e338e273e77e"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameter.LBIdNotFound 负载均衡实例ID错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.Length 参数长度错误。
UnauthorizedOperation 未授权操作。
UnsupportedOperation 操作不支持。