1. 接口描述
接口请求域名: bmlb.tencentcloudapi.com 。
查找绑定了某主机或者有某转发域名黑石负载均衡七层监听器。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeL7ListenerInfo。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
LoadBalancerId | 是 | String | 负载均衡实例ID,可通过接口DescribeLoadBalancers查询。 |
SearchKey | 否 | String | 查找的键值,可用于模糊查找有该转发域名的监听器。 |
InstanceIds.N | 否 | Array of String | 主机ID或虚机IP列表,可用于获取绑定了该主机的监听器。 |
IfGetBackendInfo | 否 | Integer | 是否获取转发规则下的主机信息。默认为0,不获取。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ListenerSet | Array of L7ListenerInfo | 返回的七层监听器列表。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查找绑定了某主机或者有某转发域名黑石负载均衡七层监听器
输入示例
https://bmlb.tencentcloudapi.com/?Action=DescribeL7ListenerInfo
&LoadBalancerId=lb-47gazeml
&IfGetBackendInfo=1
&<公共请求参数>
输出示例
{
"Response": {
"ListenerSet": [
{
"ListenerId": "lbl-n0sfq477",
"ListenerName": "5555",
"Protocol": "http",
"LoadBalancerPort": 81,
"Bandwidth": 0,
"ListenerType": "L7Listener",
"SslMode": 0,
"CertId": "",
"CertCaId": "",
"Status": 1,
"AddTimestamp": "2018-11-06 15:01:49",
"RuleSet": [
{
"Domain": "e.com",
"DomainId": "dm-cqllxlnn",
"Status": 1,
"AddTimestamp": "2018-11-06 16:32:00",
"LocationSet": [
{
"Url": "/a/b/c",
"LocationId": "loc-2l0fj4ix",
"SessionExpire": 30,
"HealthSwitch": 1,
"HttpCheckPath": "/a/",
"HttpCheckDomain": "",
"IntervalTime": 60,
"HealthNum": 6,
"UnhealthNum": 5,
"HttpCodes": [
3,
4
],
"BalanceMode": "wrr",
"Status": 1,
"AddTimestamp": "2018-11-06 16:32:00",
"BackendSet": [
{
"BindType": 0,
"InstanceId": "cpm-buj66q9x",
"Alias": "(测试长期占用)amizhang-tgw测试-勿动",
"LanIp": "10.10.1.3",
"Port": 100,
"Weight": 88,
"Status": "Dead"
},
{
"BindType": 1,
"InstanceId": "",
"Alias": "",
"LanIp": "10.10.1.6",
"Port": 66,
"Weight": 100,
"Status": "Dead"
},
{
"BindType": 1,
"InstanceId": "",
"Alias": "",
"LanIp": "10.10.1.7",
"Port": 66,
"Weight": 10,
"Status": "Dead"
}
]
}
]
}
]
}
],
"RequestId": "a3f7b4f4-a17d-4483-a93f-ab7d698e68b1"
}
}
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 | 资源不存在。 |