文档中心 负载均衡 API 文档 应用型负载均衡相关接口 获取应用型负载均衡后端的健康检查状态

获取应用型负载均衡后端的健康检查状态

最近更新时间:2019-05-14 17:03:30

1. 接口描述

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

DescribeTargetHealth 接口用来获取应用型负载均衡后端的健康检查结果。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:clb.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
LoadBalancers Array of LoadBalancerHealth 负载均衡实例列表
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

https://clb.tencentcloudapi.com/?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"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

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