文档

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

更新时间:

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

接口说明

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

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

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

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

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

rg-acfm2pz25js****
Domainstring

要查询的网站域名。

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

要查询的 CNAME 地址。

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

查询匹配模式。取值:

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

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

1
PageSizeinteger

分页查询时,设置每页包含转发规则的数量。取值范围:1~10

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
WebRulesobject []

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

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:表示域名经营的业务不符合监管要求。

如果同时包含原因 12,该参数返回 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
ProxyTypesobject []

转发协议和端口配置。

ProxyTypestring

转发协议类型。取值:

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

端口列表。

string

端口。

443
RealServersobject []

源站服务器地址信息。

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
CertRegionstring

证书区域。取值:

  • cn-hangzhou:中国大陆地区(默认)
  • ap-southeast-1:非中国大陆地区。
cn-hangzhou

示例

正常返回示例

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": false,
      "CcRuleEnabled": false,
      "OcspEnabled": false,
      "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
      },
      "CertRegion": "cn-hangzhou"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-18OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)