调用CreateWebRule创建一条网站业务转发规则。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateWebRule |
要执行的操作。取值:CreateWebRule。 |
RegionId | String | 否 | cn-hangzhou |
DDoS高防实例所属地域ID。取值:
|
ResourceGroupId | String | 否 | rg-acfm2pz25js**** |
DDoS高防实例在资源管理服务中所属的资源组ID。默认为空,即属于默认资源组。 关于资源组的更多信息,请参见创建资源组。 |
Domain | String | 是 | www.aliyun.com |
要接入DDoS高防进行防护的网站域名。 |
RsType | Integer | 是 | 0 |
源站服务器的地址类型。取值:
|
Rules | String | 是 | [{"ProxyRules":[{"ProxyPort":443,"RealServers":["192.XX.XX.1"]}],"ProxyType":"https"}] |
网站业务转发规则的详细配置。使用JSON数组转化的字符串格式表示。JSON数组中的每个元素是一个JSON结构体,包含以下字段:
|
HttpsExt | String | 否 | {"Http2":1,"Http2https":1,"Https2http":1} |
HTTPS高级设置,仅在网站协议类型支持HTTPS(ProxyType包含https)时生效。使用JSON结构体转化的字符串格式表示,JSON结构体包含以下字段:
|
DefenseId | String | 否 | aaa.bbb.cn |
要关联的防护ID。该参数适用于其他云服务(例如对象存储OSS)集成了DDoS高防的场景。 说明 该参数在内部测试中,暂时请勿使用。
示例:如果您的OSS服务集成了DDoS高防,则高防会为OSS生产账号分配一组IP资源池,每一个IP资源对应唯一的防护ID。防护ID是一个CNAME地址,该CNAME默认解析到对应的高防IP。防护ID(即CNAME)可以通过解析复用同一个IP,便于灵活调度。 说明 不允许同时填写InstanceIds和DefenseId。
|
InstanceIds.N | String | 否 | ddoscoo-cn-i7m27nf3**** |
要关联的DDoS高防实例的ID。不设置该参数表示只添加网站域名,不关联高防实例。 说明 您可以调用DescribeInstanceIds查询所有DDoS高防实例的ID信息。
|
调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数。
调用API的请求格式,请参见本文示例中的请求示例。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | CB3261D2-7D1B-4ADA-9E98-A200B2CDA2DC |
本次请求的ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateWebRule
&Domain=www.aliyun.com
&RsType=0
&Rules=[{"ProxyRules":[{"ProxyPort":443,"RealServers":["192.XX.XX.1"]}],"ProxyType":"https"}]
&HttpsExt={"Http2":1,"Http2https":1,"Https2http":1}
&InstanceIds=["ddoscoo-cn-i7m27nf3****"]
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateWebRuleResponse>
<RequestId>CB3261D2-7D1B-4ADA-9E98-A200B2CDA2DC</RequestId>
</CreateWebRuleResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "CB3261D2-7D1B-4ADA-9E98-A200B2CDA2DC"
}
错误码
访问错误中心查看更多错误码。