1. 接口描述
接口请求域名: clb.tencentcloudapi.com 。
DescribeRewrite 接口可根据负载均衡实例ID,查询一个负载均衡实例下转发规则的重定向关系。如果不指定监听器ID或转发规则ID,则返回该负载均衡实例下的所有重定向关系。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRewrite。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-17。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
LoadBalancerId | 是 | String | 负载均衡实例ID。 示例值:lb-qc2i**** |
SourceListenerIds.N | 否 | Array of String | 负载均衡监听器ID数组。 示例值:["lbl-j36caqde\r\n"] |
SourceLocationIds.N | 否 | Array of String | 负载均衡转发规则的ID数组。 示例值:["loc-5t7526km\r\n"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RewriteSet | Array of RuleOutput | 重定向转发规则构成的数组,若无重定向规则,则返回空数组。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 指定转发规则ID查询重定向关系
指定转发规则ID查询重定向关系
输入示例
https://clb.tencentcloudapi.com/?Action=DescribeRewrite
&LoadBalancerId=lb-qc2iq5yc
&SourceListenerIds.0=lbl-j36caqde
&SourceLocationIds.0=loc-5t7526km
&<公共请求参数>
输出示例
{
"Response": {
"RewriteSet": [
{
"TargetType": "Node",
"DefaultServer": false,
"Certificate": {
"SSLMode": "UNIDIRECTIONAL",
"CertCaId": "xx",
"CertId": "xx",
"ExtCertIds": [
"xx"
]
},
"TrpcCallee": "abc",
"ListenerId": "lbl-xxxxxxxx",
"WafDomainId": "xx",
"HttpGzip": true,
"Scheduler": "WRR",
"TargetGroupList": [
{
"TargetGroupId": "lbtg-xxxxxxxx",
"TargetGroupName": "testGroup"
}
],
"TargetGroup": {
"TargetGroupId": "lbtg-xxxxxxxx",
"TargetGroupName": "testGroup"
},
"Url": "/",
"HealthCheck": {
"RecvContext": "test",
"HealthSwitch": 1,
"HttpCheckPath": "/check",
"HttpCheckMethod": "head",
"UnHealthNum": 3,
"IntervalTime": 5,
"HttpCode": 15,
"SourceIpType": 0,
"CheckPort": 0,
"ContextType": "HTTP",
"HttpCheckDomain": "test.xxx.com",
"ExtendedCode": "12",
"HealthNum": 3,
"TimeOut": 2,
"CheckType": "TCP ",
"SendContext": "abc",
"HttpVersion": "HTTP/1.0"
},
"TrpcFunc": "trpcfunc_xxx",
"Http2": false,
"Domains": [
"test.abc.com"
],
"BeAutoCreated": false,
"Domain": "test.abc.com",
"ForwardType": "HTTP",
"RewriteTarget": {
"TargetListenerId": "lbl-xxxxxxxx",
"RewriteType": "Manual",
"RewriteCode": 0,
"TargetLocationId": "loc-xxxxxxxx",
"TakeUrl": true
},
"QuicStatus": "OFF",
"LocationId": "loc-xxxxxxxx",
"SessionExpireTime": 0,
"CreateTime": "2022-03-23 10:37:16"
}
],
"RequestId": "63bee47c-2bf9-4909-a8f7-67495dfe7b42"
}
}
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 | 参数错误。 |
InvalidParameter.FormatError | 参数格式错误。 |
InvalidParameter.LBIdNotFound | 负载均衡实例ID错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Length | 参数长度错误。 |
LimitExceeded | 超过配额限制。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation | 未授权操作。 |