文档中心>负载均衡>API 文档>负载均衡相关接口>拉取配置绑定的server或location

拉取配置绑定的server或location

最近更新时间:2024-03-12 01:17:39

我的收藏

1. 接口描述

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

拉取配置绑定的 server 或 location,如果 domain 存在,结果将根据 domain 过滤。或拉取配置绑定的 loadbalancer。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCustomizedConfigAssociateList。
Version String 公共参数,本接口取值:2018-03-17。
Region String 公共参数,详见产品支持的 地域列表
UconfigId String 配置ID
示例值:pz-fi018waq
Offset Integer 拉取绑定关系列表开始位置,默认值 0
示例值:0
Limit Integer 拉取绑定关系列表数目,默认值 20
示例值:3
Domain String 搜索域名
示例值:a.cc

3. 输出参数

参数名称 类型 描述
BindList Array of BindDetailItem 绑定关系列表
TotalCount Integer 绑定关系总数目
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 拉取配置绑定的server或location

拉取配置绑定的server或location

输入示例

https://clb.tencentcloudapi.com/?Action=DescribeCustomizedConfigAssociateList
&UconfigId=pz-fi018waq
&Offset=0
&Limit=3
&<公共请求参数>

输出示例

{
    "Response": {
        "BindList": [
            {
                "LoadBalancerId": "lb-az5a9oyo",
                "ListenerId": "lbl-nppnktey",
                "Domain": "www.aaa.com",
                "LocationId": "loc-nppnktey",
                "ListenerName": "test",
                "Protocol": "http",
                "Vport": 80,
                "Url": "",
                "UconfigId": "pz-n651fsue"
            }
        ],
        "TotalCount": 1,
        "RequestId": "83129908-a282-4f9f-8ab-131a3025ba11"
    }
}

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.Length 参数长度错误。
MissingParameter 缺少参数错误。
UnauthorizedOperation 未授权操作。