全部产品
Search

搜索本产品

    DDoS 防护：DescribeWebRules - 查询已经创建的网站业务转发规则

    文档中心

    DDoS 防护：DescribeWebRules - 查询已经创建的网站业务转发规则

    更新时间：Feb 07, 2023

    查询网站业务转发规则的配置。

    接口说明

    本接口用于分页查询您已创建的网站业务转发规则的配置，例如，转发协议类型、源站服务器地址、HTTPS配置、IP黑名单配置等。

    调用本接口前，您必须已经调用CreateWebRule创建了网站业务转发规则。

    QPS限制

    本接口的单用户QPS限制为50次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。

    调试

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

    调试

    授权信息

    当前API暂无授权信息透出。

    请求参数

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

    DDoS高防实例在资源管理服务中所属的资源组ID。

    不设置该参数表示默认资源组。

    		rg-acfm2pz25js****
    Domainstring否

    要查询的网站域名。

    说明域名必须已经配置过网站业务转发规则。您可以调用DescribeDomains查询所有已经配置过网站业务转发规则的域名。
    		example.com
    Cnamestring否

    要查询的CNAME地址。

    		kzmk7b8tt351****.aliyunddos1014****
    QueryDomainPatternstring否

    查询匹配模式。取值：

    • fuzzy（默认）：表示模糊查询。
    • exact：表示精确查询。
    		exact
    PageNumberinteger否

    分页查询时，设置当前页面的页码。默认值为1。

    		1
    PageSizeinteger是

    分页查询时，设置每页包含转发规则的数量。

    		10
    InstanceIdsarray否

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

    string否

    要查询的DDoS高防实例的ID。N的最大值：200，即最多可配置200个DDoS高防实例，实例ID之间用半角逗号（,）隔开。

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

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

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

    返回参数

    名称类型描述示例值
    object
    TotalCountlong

    查询到的网站业务转发规则的总数量。

    		1
    RequestIdstring

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

    		0F5B72DD-96F4-423A-B12B-A5151DD746B8
    WebRulesarray

    网站业务转发规则的配置。

    object
    Domainstring

    网站域名。

    		example.com
    Http2HttpsEnableboolean

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

    • true：表示已开启。
    • false：表示未开启。
    		true
    SslProtocolsstring

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

    • tls1.0：表示支持TLS 1.0及以上版本。
    • tls1.1：表示支持TLS 1.1及以上版本。
    • tls1.2：表示支持TLS 1.2及以上版本。
    		tls1.1
    PunishReasoninteger

    域名受到违规处罚的原因。取值：

    • 1：表示域名未履行ICP备案。
    • 2：表示域名经营的业务不符合监管要求。

    如果同时包含原因1和2，该参数返回2。

    		1
    CcTemplatestring

    频率控制防护（CC防护）的模式。取值：

    • default：表示正常模式。
    • gf_under_attack：表示攻击紧急模式。
    • gf_sos_verify：表示严格模式。
    • gf_sos_enhance：表示超级严格模式。
    		default
    CcEnabledboolean

    是否开启了频率控制防护（CC防护）。取值：

    • true：表示已开启。
    • false：表示未开启。
    		true
    SslCiphersstring

    加密套件的类型。取值：

    • default：表示自定义加密套件。
    • all：表示全部加密套件，包含强加密套件和弱加密套件。
    • strong：表示强加密套件。
    		default
    Ssl13Enabledboolean

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

    • true：表示已开启。
    • false：表示未开启。
    		false
    CcRuleEnabledboolean

    是否开启了自定义频率控制防护（CC防护）。取值：

    • true：表示已开启。
    • false：表示未开启。
    		false
    OcspEnabledboolean

    是否启用了OCSP（Online Certificate Status Protocol）功能。取值：

    • true：表示已开启。
    • false：表示未开启。
    		false
    PunishStatusboolean

    域名是否受到违规处罚。取值：

    • true：表示已受到违规处罚。您可以通过PunishReason查看受到违规处罚的具体原因。
    • false：表示未受到违规处罚。
    		true
    ProxyEnabledboolean

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

    • true：表示已开启。
    • false：表示未开启。
    		true
    CertNamestring

    证书名称。

    		testcert
    PolicyModestring

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

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

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

    		kzmk7b8tt351****.aliyunddos1014****
    Http2Enableboolean

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

    • true：表示已开启。
    • false：表示未开启。
    		true
    Https2HttpEnableboolean

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

    • true：表示已开启。
    • false：表示未开启。
    		true
    ProxyTypesarray

    转发协议和端口配置。

    object
    ProxyTypestring

    转发协议类型。取值：

    • http：表示HTTP协议。
    • https：表示HTTPS协议。
    • websocket：表示WebSocket协议。
    • websockets：表示WebSockets协议。
    		https
    ProxyPortsarray

    端口列表。

    string

    端口。

    		443
    RealServersarray

    源站服务器地址信息。

    object
    RsTypeinteger

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

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

    源站服务器地址。

    		192.0.XX.XX
    WhiteListarray

    IP白名单（针对域名）列表。

    string

    针对该域名的白名单IP。

    说明仅在您已经为该域名配置了IP白名单（针对域名）时返回该结果。您可以调用ConfigWebIpSet为网站域名配置IP黑白名单。
    		192.168.XX.XX
    BlackListarray

    IP黑名单（针对域名）列表。

    string

    针对该域名的黑名单IP。

    说明仅在您已经为该域名配置了IP黑名单（针对域名）时返回该结果。您可以调用ConfigWebIpSet为网站域名配置IP黑白名单。
    		192.0.XX.XX
    CustomCiphersarray

    自定义加密套件列表。

    string

    自定义加密套件。

    		ECDHE-ECDSA-AES128-GCM-SHA256
    GmCertobject

    国密相关配置。

    CertIdstring

    国密标准证书的ID。

    		725****
    GmEnablelong

    是否启用了国密验证功能。

    • 0：关闭
    • 1：开启
    		1
    GmOnlylong

    是否开启了仅支持国密客户端访问。

    • 0：关闭
    • 1：开启
    		1

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": 1,
  "RequestId": "0F5B72DD-96F4-423A-B12B-A5151DD746B8",
  "WebRules": [
    {
      "Domain": "example.com",
      "Http2HttpsEnable": true,
      "SslProtocols": "tls1.1",
      "PunishReason": 1,
      "CcTemplate": "default",
      "CcEnabled": true,
      "SslCiphers": "default",
      "Ssl13Enabled": true,
      "CcRuleEnabled": true,
      "OcspEnabled": true,
      "PunishStatus": true,
      "ProxyEnabled": true,
      "CertName": "testcert",
      "PolicyMode": "ip_hash",
      "Cname": "kzmk7b8tt351****.aliyunddos1014****",
      "Http2Enable": true,
      "Https2HttpEnable": true,
      "ProxyTypes": [
        {
          "ProxyType": "https",
          "ProxyPorts": [
            "443"
          ]
        }
      ],
      "RealServers": [
        {
          "RsType": 0,
          "RealServer": "192.0.XX.XX"
        }
      ],
      "WhiteList": [
        "192.168.XX.XX"
      ],
      "BlackList": [
        "192.0.XX.XX"
      ],
      "CustomCiphers": [
        "ECDHE-ECDSA-AES128-GCM-SHA256"
      ],
      "GmCert": {
        "CertId": "725****",
        "GmEnable": 1,
        "GmOnly": 1
      }
    }
  ]
}

    错误码

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