创建监听器转发规则

最近更新时间:2019-08-09 19:18:43

1. 接口描述

接口请求域名: gaap.tencentcloudapi.com 。

该接口(CreateRule)用于创建HTTP/HTTPS监听器转发规则。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateRule
Version String 公共参数,本接口取值:2018-05-29
Region String 公共参数,本接口不需要传递此参数。
ListenerId String 7层监听器ID
Domain String 转发规则的域名
Path String 转发规则的路径
RealServerType String 转发规则对应源站的类型,支持IP和DOMAIN类型。
Scheduler String 规则转发源站调度策略,支持轮询(rr),加权轮询(wrr),最小连接数(lc)。
HealthCheck Integer 规则是否开启健康检查,1开启,0关闭。
CheckParams RuleCheckParams 源站健康检查相关参数
ForwardProtocol String 加速通道转发到源站的协议类型:支持HTTP或HTTPS。
不传递该字段时表示使用对应监听器的ForwardProtocol。

3. 输出参数

参数名称 类型 描述
RuleId String 创建转发规则成功返回规则ID
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建监听器转发规则

创建HTTP/HTTPS监听器转发规则

输入示例

https://gaap.tencentcloudapi.com/?Action=CreateRule
&RealServerType=IP
&ListenerId=listener-9jt0rtv9
&Scheduler=rr
&Path=%2Fimage
&CheckParams.StatusCode.0=100
&CheckParams.StatusCode.2=200
&CheckParams.StatusCode.1=300
&CheckParams.StatusCode.3=400
&CheckParams.StatusCode.4=500
&CheckParams.DelayLoop=39
&CheckParams.Path=%2F
&CheckParams.Method=HEAD
&CheckParams.ConnectTimeout=4
&Language=zh-CN
&HealthCheck=1
&Domain=www.bbb.com
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "f3ab4984-dfe0-4c6f-aca0-32100550f6fd",
    "RuleId": "rule-qws4fmyl"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
FailedOperation.InstanceStatusNotInRuning 通道状态为非运行状态,无法操作。
FailedOperation.LimitNumofRules 转发规则数超过限制。
FailedOperation.ListenerHasTask 监听器正在操作中,请勿重复操作。
FailedOperation.NotSupportOldVersionProxy 仅支持Version2.0的通道。
FailedOperation.RuleAlreadyExisted 规则已经存在。
InternalError 内部错误
InvalidParameter 参数错误
InvalidParameterValue 参数取值错误
MissingParameter 缺少参数错误
ResourceNotFound 资源不存在
UnauthorizedOperation 未授权操作