1. 接口描述
接口请求域名: clb.tencentcloudapi.com 。
用户手动配置原访问地址和重定向地址,系统自动将原访问地址的请求重定向至对应路径的目的地址。同一域名下可以配置多条路径作为重定向策略,实现http/https之间请求的自动跳转。设置重定向时,需满足如下约束条件:若A已经重定向至B,则A不能再重定向至C(除非先删除老的重定向关系,再建立新的重定向关系),B不能重定向至任何其它地址。
本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ManualRewrite。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-17。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
LoadBalancerId | 是 | String | 负载均衡实例 ID。 示例值:lb-51jj**** |
SourceListenerId | 是 | String | 源监听器 ID。 示例值:lbl-0non**** |
TargetListenerId | 是 | String | 目标监听器 ID。 示例值:lbl-r4ia**** |
RewriteInfos.N | 是 | Array of RewriteLocationMap | 转发规则之间的重定向关系。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 手动添加一条重定向关系
输入示例
https://clb.tencentcloudapi.com/?Action=ManualRewrite
&LoadBalancerId=lb-r6nx1iby
&SourceListenerId=lbl-cy6akv52
&TargetListenerId=lbl-cy6ak123
&RewriteInfos.0.SourceLocationId=loc-2jkimjn0
&RewriteInfos.0.TargetLocationId=loc-eu15yo84
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "fc0ed756-c311-41c8-a22d-64f88a346951"
}
}
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 | 操作失败。 |
FailedOperation.InvalidLBStatus | LB状态异常。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.FormatError | 参数格式错误。 |
InvalidParameter.LBIdNotFound | 负载均衡实例ID错误。 |
InvalidParameter.ListenerIdNotFound | 监听器ID错误。 |
InvalidParameter.LocationNotFound | 查找不到符合条件的转发规则。 |
InvalidParameter.ProtocolCheckFailed | 监听器协议检查失败,比如相关协议不支持对应操作。 |
InvalidParameter.RewriteAlreadyExist | 转发规则已绑定重定向关系。 |
InvalidParameter.SomeRewriteNotFound | 一些重定向规则不存在。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Length | 参数长度错误。 |
LimitExceeded | 超过配额限制。 |
ResourceInsufficient | 资源不足。 |
UnauthorizedOperation | 未授权操作。 |