API 文档

根据证书ID查询负载均衡

最近更新时间:2021-02-04 08:15:49

我的收藏

1. 接口描述

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

根据证书ID查询其在一个地域中所关联到负载均衡实例列表

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeLoadBalancerListByCertId。
Version String 公共参数,本接口取值:2018-03-17。
Region String 公共参数,详见产品支持的 地域列表
CertIds.N Array of String 服务端证书的ID,或客户端证书的ID

3. 输出参数

参数名称 类型 描述
CertSet Array of CertIdRelatedWithLoadBalancers 证书ID,以及与该证书ID关联的负载均衡实例列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 指定的证书ID没有关联到任何负载均衡

输入示例

https://clb.tencentcloudapi.com/?Action=DescribeLoadBalancerListByCertId
&CertIds.0=RwFAfr8Y
&<公共请求参数>

输出示例

{
  "Response": {
    "CertSet": [
      {
        "CertId": "RwFAfr8Y",
        "LoadBalancers": []
      }
    ],
    "RequestId": "fe6059b5-faa6-4f21-92a1-0c9ee5df5e54"
  }
}

示例2 指定的证书ID有关联到负载均衡

输入示例

https://clb.tencentcloudapi.com/?Action=DescribeLoadBalancerListByCertId
&CertIds.0=Rrsw4nIA
&<公共请求参数>

输出示例

{
  "Response": {
    "CertSet": [
      {
        "CertId": "Rrsw4nIA",
        "LoadBalancers": [
          {
            "LoadBalancerId": "lb-rbw529fz",
            "LoadBalancerName": "test_LB",
            "Forward": 1,
            "Domain": "",
            "LoadBalancerVips": [
              "129.226.78.67"
            ],
            "LoadBalancerType": "OPEN",
            "Status": 1,
            "CreateTime": "2019-07-02 18:12:52",
            "StatusTime": "2019-07-02 21:50:07",
            "ProjectId": 0,
            "OpenBgp": 0,
            "Snat": false,
            "Isolation": 0,
            "Log": "",
            "AnycastZone": "",
            "AddressIPVersion": "ipv4",
            "VpcId": "vpc-lt9uj4mo",
            "NumericalVpcId": 117008,
            "TargetRegionInfo": {
              "Region": "ap-hongkong",
              "VpcId": "vpc-lt9uj4mo"
            },
            "SubnetId": "",
            "SecureGroups": [],
            "Tags": [],
            "VipIsp": "BGP",
            "MasterZone": null,
            "BackupZoneSet": null,
            "IsolatedTime": null,
            "ExpireTime": null,
            "ChargeType": null,
            "NetworkAttributes": null,
            "PrepaidAttributes": null
          }
        ]
      }
    ],
    "RequestId": "7718d187-7684-4294-954b-1e13009d75f6"
  }
}

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 参数长度错误。
UnauthorizedOperation 未授权操作。
目录