调用DescribeWebRules查询网站业务转发规则。

调试

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

请求参数

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

要执行的操作。取值:DescribeWebRules

PageSize Integer 10

页面显示的记录数量。最大值:10

RegionId String cn-hangzhou

DDoS高防服务地域ID。取值:

  • cn-hangzhou:表示DDoS高防(新BGP)服务
  • ap-southeast-1:表示DDoS高防(国际)服务
ResourceGroupId String default

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

Domain String www.aliyun.com

网站业务的域名。

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

查询匹配模式。取值:

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

分页查询请求时返回的页码。例如,查询第一页的返回结果,则填写1

InstanceIds.N RepeatList ddoscoo-cn-mp91j1ao****

DDoS高防实例的ID。

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

返回数据

名称 类型 示例值 描述
RequestId String 89E69DD6-C5DD-4636-9AD6-CCF6BEAB59AC

本次请求的ID。

TotalCount Long 1

返回的网站业务转发规则总数。

WebRules Array

网站业务转发规则信息。

BlackList List [1.***.***.1]

IP黑名单(针对域名)列表。

CcEnabled Boolean true

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

  • true:已开启
  • false:未开启
CcRuleEnabled Boolean false

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

  • true:已开启
  • false:未开启
CcTemplate String default

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

  • default:正常
  • gf_under_attack:攻击紧急
  • gf_sos_verify:严格
  • gf_sos_enhance:超级严格
CertName String testcert

证书名称。

Cname String 64687s1jf898****.aliyunddos0001.com

CNAME地址。

Domain String www.aliyun.com

网站域名。

Http2Enable Boolean true

是否开启了HTTP2.0。取值:

  • true:已开启
  • false:未开启
ProxyTypes Array

协议信息。

ProxyPorts List 80

服务器端口。

ProxyType String http

协议类型。取值:

  • http
  • https
  • websocket
  • websockets
RealServers Array

服务器地址信息。

RealServer String 1.***.***.1

服务器地址。

RsType Integer 0

地址类型。取值:

  • 0:源站IP
  • 1:源站域名
SslCiphers String default

加密套件类型。取值:

  • default:默认,仅包含强加密套件
  • all:全部加密套件,包含强加密套件和弱加密套件
  • strong:强加密套件
SslProtocols String tls1.0

TLS版本。取值:

  • tls1.0:支持TLS1.0及以上
  • tls1.1:支持TLS1.1及以上
  • tls1.2:支持TLS1.2及以上
WhiteList List [1.***.***.1]

IP白名单(针对域名)列表。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeWebRules
&PageSize=10
&<公共请求参数>

正常返回示例

XML 格式

<DescribeWebRulesResponse>
	  <TotalCount>1</TotalCount>
	  <WebRules>
		    <CcEnabled>true</CcEnabled>
		    <SslProtocols>tls1.0</SslProtocols>
		    <ProxyTypes>
			      <ProxyPorts>443</ProxyPorts>
			      <ProxyType>https</ProxyType>
		    </ProxyTypes>
		    <ProxyTypes>
			      <ProxyPorts>80</ProxyPorts>
			      <ProxyType>http</ProxyType>
		    </ProxyTypes>
		    <RealServers>
			      <RealServer>1.***.***.1</RealServer>
			      <RsType>0</RsType>
		    </RealServers>
		    <CcRuleEnabled>false</CcRuleEnabled>
		    <SslCiphers>default</SslCiphers>
		    <CertName></CertName>
		    <Domain>www.aliyun.com</Domain>
		    <Http2Enable>false</Http2Enable>
		    <Cname>64687s1jf898****.aliyunddos0001.com</Cname>
		    <CcTemplate>default</CcTemplate>
	  </WebRules>
	  <RequestId>89E69DD6-C5DD-4636-9AD6-CCF6BEAB59AC</RequestId>
</DescribeWebRulesResponse>

JSON 格式

{
	"TotalCount": 1,
	"WebRules": [
		{
			"CcEnabled": true,
			"SslProtocols": "tls1.0",
			"ProxyTypes": [
				{
					"ProxyPorts": [
						443
					],
					"ProxyType": "https"
				},
				{
					"ProxyPorts": [
						80
					],
					"ProxyType": "http"
				}
			],
			"RealServers": [
				{
					"RealServer": "1.***.***.1",
					"RsType": 0
				}
			],
			"CcRuleEnabled": false,
			"SslCiphers": "default",
			"CertName": "",
			"Domain": "www.aliyun.com",
			"Http2Enable": false,
			"Cname": "64687s1jf898****.aliyunddos0001.com",
			"CcTemplate": "default"
		}
	],
	"RequestId": "89E69DD6-C5DD-4636-9AD6-CCF6BEAB59AC"
}

错误码

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