1. 接口描述
接口请求域名: bmlb.tencentcloudapi.com 。
获取黑石负载均衡七层监听器绑定的主机列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeL7Backends。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
LoadBalancerId | 是 | String | 负载均衡实例ID,可通过接口DescribeLoadBalancers查询。 |
ListenerId | 是 | String | 七层监听器实例ID,可通过接口DescribeL7Listeners查询。 |
DomainId | 否 | String | 转发域名实例ID,可通过接口DescribeL7Rules查询。 |
LocationId | 否 | String | 转发路径实例ID,可通过接口DescribeL7Rules查询。 |
QueryType | 否 | String | 查询条件,传'all'则查询所有与规则绑定的主机信息。如果为all时,DomainId和LocationId参数没有意义不必传入,否则DomainId和LocationId参数必须传入。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
BackendSet | Array of L7Backend | 返回的绑定关系列表。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取黑石负载均衡七层转发路径绑定的主机列表
输入示例
https://bmlb.tencentcloudapi.com/?Action=DescribeL7Backends
&LoadBalancerId=lb-47gazeml
&ListenerId=lbl-l6fzjsx5
&DomainId=dm-hg8j52ud
&LocationId=loc-02ywyc8b
&QueryType=all
&<公共请求参数>
输出示例
{
"Response": {
"BackendSet": [
{
"BindType": 0,
"Port": 99,
"Weight": 0,
"Status": "",
"InstanceId": "tcpm-px13l9jh",
"Alias": "测试机器",
"LanIp": "10.1.100.5",
"MgtIp": "100.73.7.9",
"Operates": [
"modifyDeviceAlias",
"renewDevice",
"shutdownDevice",
"rebootDevice",
"reloadDeviceOs",
"resetPasswd",
"bindEip",
"unbindEip",
"isolateDevice",
"bindLb",
"unbindLb",
"offlineDevice",
"runUserCmd",
"changeLanIp",
"CreateCustomImage",
"bareMetalMigration"
]
},
{
"BindType": 0,
"Port": 555,
"Weight": 0,
"Status": "",
"InstanceId": "10.1.0.4",
"Alias": "",
"LanIp": "",
"MgtIp": "",
"Operates": []
},
{
"BindType": 0,
"Port": 556,
"Weight": 0,
"Status": "",
"InstanceId": "10.1.0.4",
"Alias": "",
"LanIp": "",
"MgtIp": "",
"Operates": []
}
],
"RequestId": "b858eef8-8185-4eda-95f2-afd544e62ff9"
}
}
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 | 资源不存在。 |