文档中心>负载均衡>API 文档>后端服务相关接口>查询负载均衡绑定的后端服务列表

查询负载均衡绑定的后端服务列表

最近更新时间:2024-04-03 11:13:55

我的收藏

1. 接口描述

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

DescribeTargets 接口用来查询负载均衡实例的某些监听器绑定的后端服务列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTargets。
Version String 公共参数,本接口取值:2018-03-17。
Region String 公共参数,详见产品支持的 地域列表
LoadBalancerId String 负载均衡实例 ID。
示例值:lb-10iq9lou
ListenerIds.N Array of String 监听器 ID 列表。ID 数量上限为20个。
示例值:["lbl-4fo6k8na"]
Protocol String 监听器协议类型。
示例值:HTTP
Port Integer 监听器端口。
示例值:80
Filters.N Array of Filter 查询负载均衡绑定的后端服务列表,过滤条件如下:
  • location-id - String - 是否必填:否 - (过滤条件)按照 规则ID 过滤,如:"loc-12345678"。
  • private-ip-address - String - 是否必填:否 - (过滤条件)按照 后端服务内网IP 过滤,如:"172.16.1.1"。
  • tag - String - 是否必填:否 - (过滤条件)按照 标签 过滤,如:"tag-test"。
  • 3. 输出参数

    参数名称 类型 描述
    Listeners Array of ListenerBackend 监听器后端绑定的机器信息。
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 通过Location过滤查询后端服务列表

    当负载均衡的7层监听器规则太多,而只想查询某个规则下的服务列表时,可通过Filters过滤location-id。

    输入示例

    https://clb.tencentcloudapi.com/?Action=DescribeTargets
    &LoadBalancerId=lb-12345678
    &Filters.0.Name=location-id
    &Filters.0.Values.0=loc-12345678
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "Listeners": [
                {
                    "ListenerId": "lbl-12345678",
                    "Protocol": "HTTP",
                    "Port": 80,
                    "Rules": [
                        {
                            "LocationId": "loc-12345678",
                            "Domain": "123.com",
                            "Url": "/",
                            "Targets": [
                                {
                                    "Type": "CVM",
                                    "InstanceId": "ins-12345678",
                                    "Port": 80,
                                    "Weight": 10,
                                    "PublicIpAddresses": null,
                                    "PrivateIpAddresses": [
                                        "172.16.0.100"
                                    ],
                                    "InstanceName": "123",
                                    "RegisteredTime": "2023-01-01",
                                    "EniId": "eni-12345678"
                                }
                            ],
                            "FunctionTargets": null
                        }
                    ],
                    "Targets": null,
                    "EndPort": 0
                }
            ],
            "RequestId": "038afb75-7303-48da-abdc-e25f0cbfda0f"
        }
    }

    示例2 查询负载均衡实例上绑定的所有后端服务

    查询负载均衡实例上绑定的所有后端服务

    输入示例

    https://clb.tencentcloudapi.com/?Action=DescribeTargets
    &LoadBalancerId=lb-10iq9lou
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "Listeners": [
                {
                    "ListenerId": "lbl-4fo6k8na",
                    "Protocol": "HTTP",
                    "Port": 80,
                    "Rules": [
                        {
                            "LocationId": "loc-o9732aw0",
                            "Domain": "www.123.com",
                            "Url": "/",
                            "Targets": [
                                {
                                    "Type": "cvm",
                                    "PrivateIpAddresses": [
                                        "172.16.0.12"
                                    ],
                                    "EniId": "",
                                    "PublicIpAddresses": null,
                                    "InstanceName": "abcd1234",
                                    "Port": 555,
                                    "Weight": 10,
                                    "InstanceId": "ins-19425y2y",
                                    "RegisteredTime": "2019-07-12 16:22:02"
                                }
                            ],
                            "FunctionTargets": []
                        }
                    ],
                    "Targets": null
                },
                {
                    "ListenerId": "lbl-4ue2rpl2",
                    "Protocol": "TCP",
                    "Port": 888,
                    "Rules": null,
                    "Targets": [
                        {
                            "Type": "cvm",
                            "PrivateIpAddresses": [
                                "172.16.0.12"
                            ],
                            "EniId": "",
                            "PublicIpAddresses": null,
                            "InstanceName": "abcd1234",
                            "Port": 666,
                            "Weight": 40,
                            "InstanceId": "ins-19425y2y",
                            "RegisteredTime": "2019-07-12 16:22:54"
                        }
                    ]
                }
            ],
            "RequestId": "a5cbe92d-c7f2-41d4-8343-3cb42c3fd1dd"
        }
    }

    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 参数格式错误。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.InvalidFilter Filter参数输入错误。
    InvalidParameterValue.Length 参数长度错误。
    UnauthorizedOperation 未授权操作。
    UnsupportedOperation 操作不支持。