查询负载均衡转发规则的重定向关系

最近更新时间: 2026-09-17 00:04:35

1. 接口描述

接口请求域名： clb.api3.fincloud.tencent.cn。

DescribeRewrite 接口可根据负载均衡实例ID，查询一个负载均衡实例下转发规则的重定向关系。如果不指定监听器ID或转发规则ID，则返回该负载均衡实例下的所有重定向关系。

默认接口请求频率限制：20次/秒。

接口更新时间：2020-01-10 20:29:39。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeRewrite
Version	是	否	String	公共参数，本接口取值：2018-03-17
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
LoadBalancerId	是	否	String	负载均衡实例ID 示例值： lb-qc2iji93
SourceListenerIds	否	否	Array of String	负载均衡监听器ID数组示例值： ["lbl-j36caqde"]
SourceLocationIds	否	否	Array of String	负载均衡转发规则的ID数组示例值： ["loc-5t7526km"]

3. 输出参数

参数名称	类型	描述
RewriteSet	Array of RuleOutput	重定向转发规则构成的数组，若无重定向规则，则返回空数组示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误
InternalError	内部错误
UnauthorizedOperation	未授权操作
ResourceInsufficient	资源不足
LimitExceeded	超过配额限制
FailedOperation	操作失败
InvalidParameter.FormatError	参数格式错误。
InvalidParameterValue.Length	参数长度错误。
InvalidParameter.LBIdNotFound	负载均衡实例ID错误。

5. 示例

示例1 指定转发规则ID查询重定向关系

输入示例

https://clb.api3.fincloud.tencent.cn/?Action=DescribeRewrite
&LoadBalancerId=lb-qc2iq5yc
&SourceListenerIds.0=lbl-j36caqde
&SourceLocationIds.0=loc-5t7526km
&<公共请求参数>

输出示例

{
    "Response": {
        "RewriteSet": [
            {
                "ListenerId": "lbl-j36caqde",
                "LocationId": "loc-5t7526km",
                "Domain": "www.123.com",
                "Url": "/",
                "Certificate": null,
                "HealthCheck": {
                    "HealthSwitch": 1,
                    "TimeOut": 2,
                    "IntervalTime": 5,
                    "HealthNum": 3,
                    "UnHealthNum": 3,
                    "HttpCode": 15,
                    "HttpCheckPath": "/",
                    "HttpCheckDomain": "www.123.com",
                    "HttpCheckMethod": "get"
                },
                "RewriteTarget": {
                    "TargetListenerId": "lbl-9nj07x0m",
                    "TargetLocationId": "loc-8gdc4qcq"
                },
                "SessionExpireTime": 0,
                "Scheduler": "WRR",
                "HttpGzip": true,
                "BeAutoCreated": false,
                "DefaultServer": false,
                "Http2": false
            }
        ],
        "RequestId": "6b4b80ba-12f6-4b7c-9eba-c9203b3bbf1e"
    }
}