1. 接口描述
接口请求域名： bmlb.tencentcloudapi.com 。
获取黑石负载均衡实例列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeLoadBalancers。 |
| Version | 是 | String | 公共参数，本接口取值：2018-06-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| LoadBalancerIds.N | 否 | Array of String | 负载均衡器ID数组 |
| LoadBalancerType | 否 | String | 负载均衡的类型 : open表示公网LB类型，internal表示内网LB类型 |
| LoadBalancerName | 否 | String | 负载均衡器名称 |
| Domain | 否 | String | 负载均衡域名。规则：1-60个小写英文字母、数字、点号“.”或连接线“-”。内网类型的负载均衡不能配置该字段 |
| LoadBalancerVips.N | 否 | Array of String | 负载均衡获得的公网IP地址,支持多个 |
| Offset | 否 | Integer | 数据偏移量，默认为0 |
| Limit | 否 | Integer | 返回数据长度，默认为20 |
| SearchKey | 否 | String | 模糊查找名称、域名、VIP |
| OrderBy | 否 | String | 排序字段，支持：loadBalancerName,createTime,domain,loadBalancerType |
| OrderType | 否 | Integer | 1倒序，0顺序，默认顺序 |
| ProjectId | 否 | Integer | 项目ID |
| Exclusive | 否 | Integer | 是否筛选独占集群，0表示非独占集群，1表示四层独占集群，2表示七层独占集群，3表示四层和七层独占集群，4表示共享容灾 |
| TgwSetType | 否 | String | 该负载均衡对应的tgw集群（fullnat,tunnel,dnat） |
| VpcId | 否 | String | 该负载均衡对应的所在的私有网络ID |
| QueryType | 否 | String | 'CONFLIST' 查询带confId的LB列表，'CONFID' 查询某个confId绑定的LB列表 |
| ConfId | 否 | String | 个性化配置ID |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| LoadBalancerSet | Array of LoadBalancer | 返回负载均衡信息列表。 |
| TotalCount | Integer | 符合条件的负载均衡总数。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取黑石负载均衡实例列表
输入示例
https://bmlb.tencentcloudapi.com/?Action=DescribeLoadBalancers
&Offset=0
&Limit=100
&<公共请求参数>输出示例
{
"Response": {
"LoadBalancerSet": [
{
"LoadBalancerId": "lb-ltud7t8n",
"ProjectId": 0,
"LoadBalancerName": "ami-v6-bak",
"LoadBalancerType": "open",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "604.bj.251000873.hslb.myqcloud.com",
"VpcId": "vpc-34cxlz7z",
"SubnetId": "",
"Status": 1,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-11-05 20:15:33",
"StatusTime": "2018-11-06 11:52:13",
"VpcName": "test",
"VpcCidrBlock": "10.10.0.0/16",
"LoadBalancerVips": [
"115.159.240.89"
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "lbcfg-5xumxrad",
"ConfName": "guangda-test",
"LoadBalancerVipv6s": [
"2402:4E00:20:100::2:242"
],
"IpProtocolType": "ipv6",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-84k4a2rp",
"ProjectId": 0,
"LoadBalancerName": "ami-v6",
"LoadBalancerType": "open",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "5fc.bj.251000873.hslb.myqcloud.com",
"VpcId": "vpc-34cxlz7z",
"SubnetId": "",
"Status": 1,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-10-31 11:26:35",
"StatusTime": "2018-11-06 10:28:30",
"VpcName": "test",
"VpcCidrBlock": "10.10.0.0/16",
"LoadBalancerVips": [
"115.159.240.25"
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "lbcfg-5xumxrad",
"ConfName": "guangda-test",
"LoadBalancerVipv6s": [
"2402:4E00:20:100::2:232"
],
"IpProtocolType": "ipv6",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-f5elebdb",
"ProjectId": 0,
"LoadBalancerName": "ami-v4",
"LoadBalancerType": "open",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "5fb.bj.251000873.hslb.myqcloud.com",
"VpcId": "vpc-34cxlz7z",
"SubnetId": "",
"Status": 1,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-10-31 11:02:24",
"StatusTime": "2018-11-06 10:28:30",
"VpcName": "test",
"VpcCidrBlock": "10.10.0.0/16",
"LoadBalancerVips": [
"115.159.240.53"
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "lbcfg-5xumxrad",
"ConfName": "guangda-test",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-cnmtiz1j",
"ProjectId": 0,
"LoadBalancerName": "B6hNQSrERg5lxUh-0",
"LoadBalancerType": "",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "",
"VpcId": "vpc-34cxlz7z",
"SubnetId": "",
"Status": 0,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-10-30 17:19:50",
"StatusTime": "2018-10-30 17:19:50",
"VpcName": "",
"VpcCidrBlock": "",
"LoadBalancerVips": [
""
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-j3fugpgt",
"ProjectId": 0,
"LoadBalancerName": "NU2e49l75n2pArr-0",
"LoadBalancerType": "",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "",
"VpcId": "vpc-34cxlz7z",
"SubnetId": "",
"Status": 0,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-10-30 17:04:01",
"StatusTime": "2018-10-30 17:04:01",
"VpcName": "",
"VpcCidrBlock": "",
"LoadBalancerVips": [
""
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-luvk0ve5",
"ProjectId": 0,
"LoadBalancerName": "D4hkBo9lh3rIs5x-0",
"LoadBalancerType": "",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "",
"VpcId": "vpc-34cxlz7z",
"SubnetId": "",
"Status": 0,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-10-30 16:59:55",
"StatusTime": "2018-10-30 16:59:55",
"VpcName": "",
"VpcCidrBlock": "",
"LoadBalancerVips": [
""
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-9wem1d3f",
"ProjectId": 0,
"LoadBalancerName": "0goxvaS9ylRJFuR-0",
"LoadBalancerType": "",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "",
"VpcId": "vpc-muinpf9p",
"SubnetId": "",
"Status": 0,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-10-30 16:59:05",
"StatusTime": "2018-10-30 16:59:05",
"VpcName": "",
"VpcCidrBlock": "",
"LoadBalancerVips": [
""
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-cxpsclzf",
"ProjectId": 0,
"LoadBalancerName": "中文测试",
"LoadBalancerType": "internal",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "",
"VpcId": "vpc-muinpf9p",
"SubnetId": "subnet-c6bzyq4a",
"Status": 1,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-10-30 16:15:40",
"StatusTime": "2018-10-30 16:26:16",
"VpcName": "cassiehe",
"VpcCidrBlock": "10.1.0.0/16",
"LoadBalancerVips": [
"100.68.210.137"
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-m1i50ynj",
"ProjectId": 0,
"LoadBalancerName": "5dd-LB",
"LoadBalancerType": "open",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "5dd.bj.251000873.hslb.myqcloud.com",
"VpcId": "vpc-34cxlz7z",
"SubnetId": "",
"Status": 1,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-10-22 14:47:49",
"StatusTime": "2018-10-31 16:45:25",
"VpcName": "test",
"VpcCidrBlock": "10.10.0.0/16",
"LoadBalancerVips": [
"115.159.240.26"
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-m2pg9nev",
"ProjectId": 0,
"LoadBalancerName": "5db-LB",
"LoadBalancerType": "internal",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "",
"VpcId": "vpc-muinpf9p",
"SubnetId": "subnet-c6bzyq4a",
"Status": 1,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-10-18 15:53:47",
"StatusTime": "2018-10-18 15:55:57",
"VpcName": "cassiehe",
"VpcCidrBlock": "10.1.0.0/16",
"LoadBalancerVips": [
"100.68.210.136"
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-gdr96fc7",
"ProjectId": 0,
"LoadBalancerName": "5c1-LB",
"LoadBalancerType": "open",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "5c1.bj.251000873.hslb.myqcloud.com",
"VpcId": "vpc-muinpf9p",
"SubnetId": "",
"Status": 1,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-10-11 15:28:56",
"StatusTime": "2018-10-31 16:42:37",
"VpcName": "cassiehe",
"VpcCidrBlock": "10.1.0.0/16",
"LoadBalancerVips": [
"115.159.240.85"
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-14gtclwh",
"ProjectId": 0,
"LoadBalancerName": "59a-LB",
"LoadBalancerType": "open",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "59a.bj.251000873.hslb.myqcloud.com",
"VpcId": "vpc-34cxlz7z",
"SubnetId": "",
"Status": 1,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-06-07 20:54:33",
"StatusTime": "2018-10-31 19:44:12",
"VpcName": "test",
"VpcCidrBlock": "10.10.0.0/16",
"LoadBalancerVips": [
"115.159.240.22"
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-iz8b4qnf",
"ProjectId": 0,
"LoadBalancerName": "bm_ccs_master_lb",
"LoadBalancerType": "internal",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "",
"VpcId": "vpc-muinpf9p",
"SubnetId": "subnet-430cyb94",
"Status": 1,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-04-08 16:16:12",
"StatusTime": "2018-08-31 15:05:37",
"VpcName": "cassiehe",
"VpcCidrBlock": "10.1.0.0/16",
"LoadBalancerVips": [
"100.68.210.135"
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-fxzj6q3x",
"ProjectId": 0,
"LoadBalancerName": "l2t6q4pfsswJgoa-0",
"LoadBalancerType": "",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "",
"VpcId": "vpc-34cxlz7z",
"SubnetId": "",
"Status": 0,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-04-04 16:12:09",
"StatusTime": "2018-04-04 16:12:09",
"VpcName": "",
"VpcCidrBlock": "",
"LoadBalancerVips": [
""
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-9jmpocz3",
"ProjectId": 0,
"LoadBalancerName": "wDOmO0OFQjnTowN-0",
"LoadBalancerType": "",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "",
"VpcId": "vpc-34cxlz7z",
"SubnetId": "",
"Status": 0,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-04-04 16:10:51",
"StatusTime": "2018-04-04 16:10:51",
"VpcName": "",
"VpcCidrBlock": "",
"LoadBalancerVips": [
""
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-hkp82hq9",
"ProjectId": 0,
"LoadBalancerName": "rG5HM7y9lhalTXn-0",
"LoadBalancerType": "",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "",
"VpcId": "vpc-34cxlz7z",
"SubnetId": "",
"Status": 0,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-04-04 16:02:07",
"StatusTime": "2018-04-04 16:02:07",
"VpcName": "",
"VpcCidrBlock": "",
"LoadBalancerVips": [
""
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-2routcy3",
"ProjectId": 0,
"LoadBalancerName": "6HAamycPjXcGxDM-0",
"LoadBalancerType": "",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "",
"VpcId": "vpc-34cxlz7z",
"SubnetId": "",
"Status": 0,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-04-04 15:46:24",
"StatusTime": "2018-04-04 15:46:24",
"VpcName": "",
"VpcCidrBlock": "",
"LoadBalancerVips": [
""
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-qgmbvx57",
"ProjectId": 0,
"LoadBalancerName": "3mC9VTP7uQlC2J3-0",
"LoadBalancerType": "",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "",
"VpcId": "vpc-34cxlz7z",
"SubnetId": "",
"Status": 0,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-04-04 15:46:13",
"StatusTime": "2018-04-04 15:46:13",
"VpcName": "",
"VpcCidrBlock": "",
"LoadBalancerVips": [
""
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-2uuicurr",
"ProjectId": 0,
"LoadBalancerName": "ZuCUDyb1GuV3XsS-0",
"LoadBalancerType": "",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "",
"VpcId": "vpc-34cxlz7z",
"SubnetId": "",
"Status": 0,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-04-04 15:45:52",
"StatusTime": "2018-04-04 15:45:52",
"VpcName": "",
"VpcCidrBlock": "",
"LoadBalancerVips": [
""
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
},
{
"LoadBalancerId": "lb-6t7dnny9",
"ProjectId": 0,
"LoadBalancerName": "iz88GADpAwbyFu6-0",
"LoadBalancerType": "",
"Exclusive": 0,
"TgwSetType": "fullnat",
"Domain": "",
"VpcId": "vpc-34cxlz7z",
"SubnetId": "",
"Status": 0,
"PayMode": "flow",
"LatestPayMode": "flow",
"CreateTime": "2018-04-04 15:45:09",
"StatusTime": "2018-04-04 15:45:09",
"VpcName": "",
"VpcCidrBlock": "",
"LoadBalancerVips": [
""
],
"SupportListenerTypes": [
"L4Listener",
"L7Listener"
],
"Bandwidth": 0,
"ConfId": "",
"ConfName": "",
"LoadBalancerVipv6s": [
""
],
"IpProtocolType": "ipv4",
"BzPayMode": "",
"BzL4Metrics": "",
"BzL7Metrics": ""
}
],
"TotalCount": 26,
"RequestId": "f83cade7-f5ed-432c-952e-23dee4767d9e"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |