租户端 网络 负载均衡（CLB） 负载均衡相关接口 获取负载均衡后端服务的健康检查状态

获取负载均衡后端服务的健康检查状态

最近更新时间: 2026-09-17 00:04:35

1. 接口描述

接口请求域名： clb.api3.fincloud.tencent.cn。

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

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

接口更新时间：2020-01-10 20:44:19。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeTargetHealth
Version 是 否 String 公共参数，本接口取值：2018-03-17
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
LoadBalancerIds 是 否 Array of String 要查询的负载均衡实例 ID列表
示例值： ["lb-qc2iq5yc"]

3. 输出参数

参数名称 类型 描述
LoadBalancers Array of LoadBalancerHealth 负载均衡实例列表
示例值：查看
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

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

输入示例

https://clb.api3.fincloud.tencent.cn/?Action=DescribeTargetHealth
&LoadBalancerIds.0=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"
  }
}