AutoRewrite

最近更新时间: 2024-12-21 13:01:31

1. 接口描述

接口请求域名: clb.api3.gsesgpucloud.com。

用户需要先创建出一个HTTPS:443监听器,并在其下创建转发规则。通过调用本接口,系统会自动创建出一个HTTP:80监听器(如果之前不存在),并在其下创建转发规则,与HTTPS:443监听器下的Domains(在入参中指定)对应。创建成功后可以通过HTTP:80地址自动跳转为HTTPS:443地址进行访问。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。

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

接口更新时间:2024-02-18 17:59:55。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:AutoRewrite
Version String 公共参数,本接口取值:2018-03-17
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
LoadBalancerId String 负载均衡实例ID
示例值: lb-r6nx1iby
ListenerId String HTTPS:443监听器的ID
示例值: lbl-lmeeyb1q
Domains Array of String HTTPS:443监听器下需要重定向的域名
示例值: ["www.abc.com\n"]
TakeUrls Array of Bool 重定向是否携带匹配的URL
示例值: true
RewriteCodes Array of Int64 重定向状态码,可取值301,302,307。
示例值: 301

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误
InternalError 内部错误
UnauthorizedOperation 未授权操作
ResourceInsufficient 资源不足
LimitExceeded 超过配额限制
FailedOperation 操作失败
InvalidParameter.LBIdNotFound 负载均衡实例ID错误。
InvalidParameter.ListenerIdNotFound 监听器ID错误。
InvalidParameter.LocationNotFound 查找不到符合条件的转发规则。
InvalidParameter.PortCheckFailed 监听器端口检查失败,比如端口冲突。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue.Length 参数长度错误。