全球应用加速创建监听器转发规则-API 文档-文档中心-腾讯云

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateRule。
Version	是	String	公共参数，本接口取值：2018-05-29。
Region	否	String	公共参数，此参数为可选参数。
ListenerId	是	String	7层监听器ID 示例值：listener-9jt0rtv9
Domain	是	String	转发规则的域名示例值：www.bbb.com
Path	是	String	转发规则的路径示例值：%2Fimage
RealServerType	是	String	转发规则对应源站的类型，支持IP和DOMAIN类型。示例值：IP
Scheduler	是	String	监听器源站访问策略，其中：rr表示轮询；wrr表示加权轮询；lc表示最小连接数。示例值：rr
HealthCheck	是	Integer	规则是否开启健康检查，1开启，0关闭。示例值：1
CheckParams	否	RuleCheckParams	源站健康检查相关参数
ForwardProtocol	否	String	加速通道转发到源站的协议类型：支持HTTP或HTTPS。不传递该字段时表示使用对应监听器的ForwardProtocol。示例值：HTTP
ForwardHost	否	String	回源Host。加速通道转发到源站的host，不设置该参数时，使用默认的host设置，即客户端发起的http请求的host。
ServerNameIndicationSwitch	否	String	服务器名称指示（ServerNameIndication，简称SNI）开关。ON表示开启，OFF表示关闭。创建HTTP监听器转发规则时，SNI功能默认关闭。示例值：OFF
ServerNameIndication	否	String	服务器名称指示（ServerNameIndication，简称SNI），当SNI开关打开时，该字段必填。示例值：www.qq.com
ForcedRedirect	否	String	HTTP强制跳转HTTPS。输入当前规则对应的域名与地址。示例值：https://www.qq.com/url

3. 输出参数

参数名称	类型	描述
RuleId	String	创建转发规则成功返回规则ID 示例值：rule-qws4fmyl
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

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

输入示例

POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRule
<公共请求参数>

{
    "Domain": "www.bbb.com",
    "RealServerType": "IP",
    "HealthCheck": "1",
    "ListenerId": "listener-9jt0rtv9",
    "CheckParams": {
        "ConnectTimeout": "4",
        "Path": "%2F",
        "Method": "HEAD",
        "DelayLoop": "39",
        "StatusCode": [
            "300",
            "100",
            "400",
            "200",
            "500"
        ]
    },
    "Scheduler": "rr",
    "Path": "%2Fimage"
}

输出示例

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

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
AuthFailure.NotEnterpriseAuthorization	非企业认证客户。
AuthFailure.UnauthorizedOperation	子账户未授权操作。
FailedOperation	操作失败。
FailedOperation.ActionOperateTooQuickly	接口操作太频繁，请稍后重试。
FailedOperation.GroupStatusNotInRuning	通道组状态为非运行状态，无法操作。
FailedOperation.InstanceStatusNotInRuning	通道状态为非运行状态，无法操作。
FailedOperation.LimitNumofRules	转发规则数超过限制。
FailedOperation.ListenerHasTask	监听器正在操作中，请勿重复操作。
FailedOperation.NonStandardProxy	该通道为非标通道，限制所有写操作。
FailedOperation.NotSupportOldVersionProxy	仅支持Version2.0的通道。
FailedOperation.RuleAlreadyExisted	规则已经存在。
FailedOperation.UserNotConfirmProtocol	未开通协议。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
ResourceNotFound	资源不存在。
ResourceUnavailable.AccountViolation	账号下存在违规资源，详情请查看站内信或邮件。
UnauthorizedOperation	未授权操作。

创建监听器转发规则

本页目录：