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

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

1. 接口描述

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

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

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

接口更新时间：2020-01-10 20:37:15。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeTargets
Version	是	否	String	公共参数，本接口取值：2018-03-17
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
LoadBalancerId	是	否	String	负载均衡实例 ID 示例值： lb-10iq9lou
ListenerIds	否	否	Array of String	监听器 ID列表示例值： ["lbl-4fo6k8na"]
Protocol	否	否	String	监听器协议类型。支持传：TCP｜UDP｜HTTP｜HTTPS｜TCP_SSL 示例值： HTTP
Port	否	否	Int64	监听器端口示例值： 80

3. 输出参数

参数名称	类型	描述
Listeners	Array of ListenerBackend	监听器后端绑定的机器信息示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误
InternalError	内部错误
UnauthorizedOperation	未授权操作
FailedOperation	操作失败
InvalidParameter.FormatError	参数格式错误。
InvalidParameterValue.Length	参数长度错误。

5. 示例

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

输入示例

https://clb.api3.fincloud.tencent.cn/?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": "gx3gj9x7",
                                "Port": 555,
                                "Weight": 10,
                                "InstanceId": "ins-19425y2y",
                                "RegisteredTime": "2019-07-12 16:22:02"
                            }
                        ]
                    }
                ],
                "Targets": null
            },
            {
                "ListenerId": "lbl-4ue2rpl2",
                "Protocol": "TCP",
                "Port": 888,
                "Rules": null,
                "Targets": [
                    {
                        "Type": "cvm",
                        "PrivateIpAddresses": [
                            "172.16.0.12"
                        ],
                        "EniId": "",
                        "PublicIpAddresses": null,
                        "InstanceName": "gx3gj9x7",
                        "Port": 666,
                        "Weight": 40,
                        "InstanceId": "ins-19425y2y",
                        "RegisteredTime": "2019-07-12 16:22:54"
                    }
                ]
            }
        ],
        "RequestId": "a5cbe92d-c7f2-41d4-8343-3cb42c3fd1dd"
    }
}