CreateWebRule - 创建一条网站业务转发规则

创建一条网站业务转发规则。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-ddoscoo:CreateWebRulecreate
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ResourceGroupIdstring

DDoS 高防实例在资源管理服务中所属的资源组 ID。默认为空,即属于默认资源组。

关于资源组的更多信息,请参见创建资源组

rg-acfm2pz25js****
Domainstring

要接入 DDoS 高防进行防护的网站域名。

example.aliyundoc.com
RsTypeinteger

源站服务器的地址类型。取值:

  • 0:表示源站服务器的 IP 地址。
  • 1:表示源站服务器的域名地址。通常适用于源站和高防之间还部署有其他代理服务(例如 WAF)的场景,具体指代理服务的跳转地址(例如 WAF CNAME 地址)。
0
Rulesstring

网站业务转发规则的详细配置。使用 JSON 数组转化的字符串格式表示。JSON 数组中的每个元素是一个 JSON 结构体,包含以下字段:

  • ProxyRules:JSONArray 类型 | 必选 | 源站服务器信息,包括端口号和服务器地址。数组中每个元素是一个 JSON 结构体,包含以下字段:

    • ProxyPort:Integer 类型 | 必选 | 协议对应的端口号。
    • RealServers:StringArray 类型 | 必选 | 服务器地址。
  • ProxyType:String 类型 | 必选 | 网站协议类型。取值:http | https | websocket | websockets

[{"ProxyRules":[{"ProxyPort":443,"RealServers":["192.1.XX.XX"]}],"ProxyType":"https"}]
HttpsExtstring

HTTPS 高级设置,仅在网站协议类型支持 HTTPS(ProxyType 包含 https)时生效。使用 JSON 结构体转化的字符串格式表示,JSON 结构体包含以下字段:

  • Http2https:Integer 类型 | 可选 | 是否开启 HTTPS 的强制跳转功能,取值:0(表示关闭) | 1(表示开启),默认关闭。

    适用于您的网站同时支持 HTTP 和 HTTPS 协议。开启该设置后,所有 HTTP 请求将强制转换为 HTTPS 请求,且默认跳转到 443 端口。

  • Https2http:Integer 类型 | 可选 | 是否开启 HTTP 回源功能,取值:0(表示关闭) | 1(表示开启),默认关闭。

    适用于您的网站不支持 HTTPS 回源。开启该设置后,所有 HTTPS 协议请求将通过 HTTP 回源(Websockets 协议会通过 Websocket 回源),且默认回源端口为 80。

  • Http2:Integer 类型 | 可选 | 是否启用 HTTP2.0 协议类型,取值:0(表示关闭) | 1(表示开启),默认关闭。

    开启该设置后,协议版本为 HTTP2.0。

{"Http2":1,"Http2https":1,"Https2http":1}
DefenseIdstring

要关联的防护 ID。该参数适用于其他云服务(例如对象存储 OSS)集成了 DDoS 高防的场景。

说明 该参数在内部测试中,暂时请勿使用。

示例:如果您的 OSS 服务集成了 DDoS 高防,则高防会为 OSS 生产账号分配一组 IP 资源池,每一个 IP 资源对应唯一的防护 ID。防护 ID 是一个 CNAME 地址,该 CNAME 默认解析到对应的高防 IP。防护 ID(即 CNAME)可以通过解析复用同一个 IP,便于灵活调度。

说明 不允许同时填写 InstanceIdsDefenseId
testid
InstanceIdsarray

要关联的 DDoS 高防实例的 ID 列表。

string

要关联的 DDoS 高防实例的 ID。不设置该参数表示只添加网站域名,不关联高防实例。

说明 您可以调用 DescribeInstanceIds 查询所有 DDoS 高防实例的 ID 信息。
ddoscoo-cn-i7m27nf3****

调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用 API 的请求格式,请参见本文示例中的请求示例。

返回参数

名称类型描述示例值
object
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

9EC62E89-BD30-4FCD-9CB8-FA53865FF0D7

示例

正常返回示例

JSON格式

{
  "RequestId": "9EC62E89-BD30-4FCD-9CB8-FA53865FF0D7"
}

错误码

访问错误中心查看更多错误码。