调用DescribeWebRules查询已创建的网站业务转发规则。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeWebRules

要执行的操作。取值:DescribeWebRules

RegionId String cn-hangzhou

DDoS高防实例所属地域ID。取值:

  • cn-hangzhou(默认):表示中国内地,对应DDoS高防(新BGP)实例。
  • ap-southeast-1:表示非中国内地,对应DDoS高防(国际)实例。
ResourceGroupId String rg-acfm2pz25js****

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

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

Domain String www.aliyun.com

要查询的网站业务的域名。不设置该参数表示查询所有域名。

说明 域名必须已经配置网站业务转发规则。您可以调用 DescribeDomains查询所有已经配置过网站业务转发规则的域名。
QueryDomainPattern String fuzzy

查询匹配模式。取值:

  • fuzzy(默认):表示模糊查询。
  • exact:表示精确查询。
PageNumber Integer 1

分页查询时,返回第几页数据。默认值为1,表示返回第1页数据。

PageSize Integer 10

分页查询时,每页包含结果的数量。默认值为10,表示每页包含10个结果。

InstanceIds.N String ddoscoo-cn-i7m27nf3****

要查询的DDoS高防实例的ID。

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

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

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

返回数据

名称 类型 示例值 描述
TotalCount Long 1

查询到的结果的数量,即网站业务转发规则的数量。

WebRules Array of WebRule

网站业务转发规则配置。

Domain String www.aliyun.com

网站域名。

Http2HttpsEnable Boolean true

是否开启了HTTPS强制跳转功能。取值:

  • true:表示已开启。
  • false:表示未开启。
CustomCiphers Array of String ECDHE-ECDSA-AES128-GCM-SHA256

自定义加密套件。

BlackList Array of String 192.XX.XX.1

针对该域名的黑名单IP。

说明 仅在您已经为该域名配置了IP黑名单(针对域名)时返回该结果。您可以调用 ConfigWebIpSet为网站域名配置IP黑白名单。
WhiteList Array of String 192.XX.XX.2

针对该域名的白名单IP。

说明 仅在您已经为该域名配置了IP白名单(针对域名)时返回该结果。您可以调用 ConfigWebIpSet为网站域名配置IP黑白名单。
RealServers Array of RealServer

源站服务器地址信息。

RsType Integer 0

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

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

源站服务器地址。

ProxyTypes Array of ProxyConfig

转发协议和端口配置。

ProxyPorts Array of String 443

端口。

ProxyType String https

转发协议类型。取值:

  • http:表示HTTP协议。
  • https:表示HTTPS协议。
  • websocket:表示WebSocket协议。
  • websockets:表示WebSockets协议。
SslProtocols String tls1.0

支持的TLS协议版本。取值:

  • tls1.0:表示支持TLS 1.0及以上版本。
  • tls1.1:表示支持TLS 1.1及以上版本。
  • tls1.2:表示支持TLS 1.2及以上版本。
CcTemplate String default

频率控制防护(CC防护)的模式。取值:

  • default:表示正常模式。
  • gf_under_attack:表示攻击紧急模式。
  • gf_sos_verify:表示严格模式。
  • gf_sos_enhance:表示超级严格模式。
CcEnabled Boolean true

是否开启了频率控制防护(CC防护)。取值:

  • true:表示已开启。
  • false:表示未开启。
SslCiphers String default

加密套件的类型。取值:

  • default:表示自定义加密套件。
  • all:表示全部加密套件,包含强加密套件和弱加密套件。
  • strong:表示强加密套件。
CcRuleEnabled Boolean false

是否开启了自定义频率控制防护(CC防护)。取值:

  • true:表示已开启。
  • false:表示未开启。
Ssl13Enabled Boolean false

是否开启了TLS 1.3协议支持。取值:

  • true:表示已开启。
  • false:表示未开启。
ProxyEnabled Boolean true

网站业务转发是否开启。取值:

  • true:表示已开启。
  • false:表示未开启。
CertName String testcert

证书名称。

PolicyMode String ip_hash

回源负载算法的类型。取值:

  • ip_hash:表示IP Hash算法。根据请求来源IP进行HASH映射,将同一个IP的所有请求定向到一个源站服务器。
  • rr:表示轮转算法。将所有请求轮流分配给不同源站服务器。
  • least_time:表示Least Time算法。该算法通过智能DNS解析能力,保证业务流量从接入防护节点到转发回源站服务器整个链路的时延最短。
Cname String o8fzz0ocxere****.aliyunddos****.com

网站域名对应的DDoS高防CNAME地址。

Http2Enable Boolean true

是否开启了HTTP 2.0协议支持。取值:

  • true:表示已开启。
  • false:表示未开启。
Https2HttpEnable Boolean true

是否开启了HTTP回源功能。取值:

  • true:表示已开启。
  • false:表示未开启。
RequestId String 0F5B72DD-96F4-423A-B12B-A5151DD746B8

本次请求的ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeWebRules
&Domain=www.aliyun.com
&QueryDomainPattern=fuzzy
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeWebRulesResponse>
    <TotalCount>1</TotalCount>
    <WebRules>
        <Domain>www.aliyun.com</Domain>
        <Http2HttpsEnable>true</Http2HttpsEnable>
        <CustomCiphers>ECDHE-ECDSA-AES128-GCM-SHA256</CustomCiphers>
        <BlackList>192.XX.XX.1</BlackList>
        <WhiteList>192.XX.XX.2</WhiteList>
        <RealServers>
            <RsType>0</RsType>
            <RealServer>192.XX.XX.11</RealServer>
        </RealServers>
        <ProxyTypes>
            <ProxyPorts>443</ProxyPorts>
            <ProxyType>https</ProxyType>
        </ProxyTypes>
        <SslProtocols>tls1.0</SslProtocols>
        <CcTemplate>default</CcTemplate>
        <CcEnabled>true</CcEnabled>
        <SslCiphers>default</SslCiphers>
        <CcRuleEnabled>false</CcRuleEnabled>
        <Ssl13Enabled>false</Ssl13Enabled>
        <ProxyEnabled>true</ProxyEnabled>
        <CertName>testcert</CertName>
        <PolicyMode>ip_hash</PolicyMode>
        <Cname>o8fzz0ocxere****.aliyunddos****.com</Cname>
        <Http2Enable>true</Http2Enable>
        <Https2HttpEnable>true</Https2HttpEnable>
    </WebRules>
    <RequestId>0F5B72DD-96F4-423A-B12B-A5151DD746B8</RequestId>
</DescribeWebRulesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "WebRules" : [ {
    "Domain" : "www.aliyun.com",
    "Http2HttpsEnable" : true,
    "CustomCiphers" : [ "ECDHE-ECDSA-AES128-GCM-SHA256" ],
    "BlackList" : [ "192.XX.XX.1" ],
    "WhiteList" : [ "192.XX.XX.2" ],
    "RealServers" : [ {
      "RsType" : 0,
      "RealServer" : "192.XX.XX.11"
    } ],
    "ProxyTypes" : [ {
      "ProxyPorts" : [ "443" ],
      "ProxyType" : "https"
    } ],
    "SslProtocols" : "tls1.0",
    "CcTemplate" : "default",
    "CcEnabled" : true,
    "SslCiphers" : "default",
    "CcRuleEnabled" : false,
    "Ssl13Enabled" : false,
    "ProxyEnabled" : true,
    "CertName" : "testcert",
    "PolicyMode" : "ip_hash",
    "Cname" : "o8fzz0ocxere****.aliyunddos****.com",
    "Http2Enable" : true,
    "Https2HttpEnable" : true
  } ],
  "RequestId" : "0F5B72DD-96F4-423A-B12B-A5151DD746B8"
}

错误码

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