1. 接口描述
接口请求域名： bmlb.tencentcloudapi.com 。
获取黑石负载均衡七层转发规则。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeL7Rules。 |
| Version | 是 | String | 公共参数，本接口取值：2018-06-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| LoadBalancerId | 是 | String | 负载均衡实例ID，可通过接口DescribeLoadBalancers查询。 |
| ListenerId | 是 | String | 七层监听器ID，可通过接口DescribeL7Listeners查询。 |
| DomainIds.N | 否 | Array of String | 转发域名ID列表，可通过接口DescribeL7Rules查询。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RuleSet | Array of L7Rule | 返回的转发规则列表。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取黑石负载均衡七层转发规则
输入示例
https://bmlb.tencentcloudapi.com/?Action=DescribeL7Rules
&LoadBalancerId=lb-47gazeml
&ListenerId=lbl-l6fzjsx5
&<公共请求参数>输出示例
{
"Response": {
"RuleSet": [
{
"Domain": "b.com",
"DomainId": "dm-ftaez2bl",
"Status": 1,
"AddTimestamp": "2018-11-06 15:45:12",
"LocationSet": [
{
"Url": "/",
"LocationId": "loc-bwxdimq5",
"SessionExpire": 0,
"HealthSwitch": 1,
"HttpCheckPath": "/a/",
"HttpCheckDomain": "b.com",
"IntervalTime": 30,
"HealthNum": 3,
"UnhealthNum": 3,
"HttpCodes": [
1,
2,
3,
4,
5
],
"BalanceMode": "wrr",
"Status": 1,
"AddTimestamp": "2018-11-06 15:45:12"
}
]
},
{
"Domain": "c.com",
"DomainId": "dm-mq3qr5v3",
"Status": 1,
"AddTimestamp": "2018-11-06 15:56:58",
"LocationSet": [
{
"Url": "/",
"LocationId": "loc-rm84yp9j",
"SessionExpire": 0,
"HealthSwitch": 1,
"HttpCheckPath": "/a/",
"HttpCheckDomain": "c.com",
"IntervalTime": 30,
"HealthNum": 3,
"UnhealthNum": 3,
"HttpCodes": [
1,
2,
3,
4,
5
],
"BalanceMode": "wrr",
"Status": 1,
"AddTimestamp": "2018-11-06 15:56:58"
}
]
},
{
"Domain": "d.com",
"DomainId": "dm-eih4t7tx",
"Status": 1,
"AddTimestamp": "2018-11-06 16:17:24",
"LocationSet": [
{
"Url": "/",
"LocationId": "loc-a91atsct",
"SessionExpire": 0,
"HealthSwitch": 1,
"HttpCheckPath": "/a/",
"HttpCheckDomain": "d.com",
"IntervalTime": 30,
"HealthNum": 3,
"UnhealthNum": 3,
"HttpCodes": [
1
],
"BalanceMode": "wrr",
"Status": 1,
"AddTimestamp": "2018-11-06 16:17:24"
}
]
},
{
"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": "e.com",
"IntervalTime": 60,
"HealthNum": 6,
"UnhealthNum": 6,
"HttpCodes": [
3,
4
],
"BalanceMode": "wrr",
"Status": 1,
"AddTimestamp": "2018-11-06 16:32:00"
}
]
}
],
"RequestId": "4576214f-c836-4579-9542-bbbe0a69c839"
}
}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 | 资源不存在。 |
