调用DescribeNetworkRuleAttributes查询非网站业务端口转发规则的防护配置,包括会话保持和DDoS防护策略。

调试

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

请求参数

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

要执行的操作。取值:DescribeNetworkRuleAttributes

NetworkRules String [{"InstanceId":"ddoscoo-cn-mp91j1ao****","Protocol":"tcp","FrontendPort":8080}]

要查询的端口转发规则,使用JSON格式的字符串表述,具体结构如下。

  • InstanceId:String类型,必选,DDoS高防实例ID。
  • Protocol:String类型,必选,转发协议类型。取值:tcpudp
  • FrontendPort:Integer类型,必选,转发端口。
RegionId String cn-hangzhou

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

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

返回数据

名称 类型 示例值 描述
NetworkRuleAttributes Array

非网站业务端口转发规则的防护配置,包括会话保持和DDoS防护策略。

Config Struct

端口转发规则的防护配置。

Cc Struct

源连接频繁超限控制策略。

Sblack Array

源连接多次超限,将源IP加入黑名单的策略。

Cnt Integer 5

源连接超过限制的次数。取值固定为5,表示如果源连接在检查间隔内超过限制5次,将源IP加入黑名单。

During Integer 60

检查间隔。取值固定为60,单位:秒。

Expires Integer 600

黑名单有效时长。取值范围:60~604800,单位:秒。

Type Integer 1

源IP黑名单配置类型。取值:

  • 1:源新建连接限速IP黑名单
  • 2:源并发连接限速IP黑名单
  • 3:源PPS限速IP黑名单
  • 4:源带宽限速IP黑名单
NodataConn String off

空连接过滤的开关状态。取值:

  • on:开启
  • off:关闭
PayloadLen Struct

包长度过滤配置。

Max Integer 6000

包长度的最大值。取值范围:0~6000,单位:Byte。

Min Integer 0

包长度的最小值。取值范围:0~6000,单位:Byte。

PersistenceTimeout Integer 0

会话保持的超时时间。取值范围:30~3600,单位:秒。默认为0,表示关闭。

Sla Struct

目的限速配置。

Cps Integer 100000

目的新建连接限速。取值范围:100~100000

CpsEnable Integer 1

目的新建连接限速的开关状态。取值:

  • 0:关闭
  • 1:开启
Maxconn Integer 1000000

目的并发连接限速。取值范围:1000~1000000

MaxconnEnable Integer 0

目的并发连接限速的开关状态。取值:

  • 0:关闭
  • 1:开启
Slimit Struct

源限速配置。

Bps Long 0

源带宽限速。取值范围:1024~268435456,单位:Byte/s。默认为0,表示未开启源带宽限速。

Cps Integer 0

源新建连接限速。取值范围:1~500000,单位:个。

CpsEnable Integer 0

源新建连接限速的开关状态。取值:

  • 0:关闭
  • 1:开启
CpsMode Integer 1

源新建连接限速的模式。取值:

  • 1:手动
  • 2:自动
Maxconn Integer 0

源并发连接限速。取值范围:1~500000,单位:个。

MaxconnEnable Integer 0

源并发连接限速的开关状态。取值:

  • 0:关闭
  • 1:开启
Pps Long 0

源PPS限速。取值范围:1~100000,单位:Packet/s。默认为0,表示未开启源PPS限速。

Synproxy String off

虚假源过滤的开关状态。取值:

  • on:开启
  • off:关闭
FrontendPort Integer 8080

转发端口。

InstanceId String ddoscoo-cn-mp91j1ao****

DDoS高防实例ID。

Protocol String tcp

转发协议。取值:

  • tcp
  • udp
RequestId String F9F2F77D-307C-4F15-8D02-AB5957EEBF97

本次请求的ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeNetworkRuleAttributes
&NetworkRules=[{"InstanceId":"ddoscoo-cn-mp91j1ao****","Protocol":"tcp","FrontendPort":8080}]
&<公共请求参数>

正常返回示例

XML 格式

<DescribeNetworkRuleAttributesResponse>
	  <NetworkRuleAttributes>
		    <InstanceId>ddoscoo-cn-mp91j1ao****</InstanceId>
		    <Config>
			      <NodataConn>off</NodataConn>
			      <Cc></Cc>
			      <PersistenceTimeout>0</PersistenceTimeout>
			      <PayloadLen>
				        <Min>0</Min>
				        <Max>6000</Max>
			      </PayloadLen>
			      <Sla>
				        <Cps>100000</Cps>
				        <CpsEnable>1</CpsEnable>
				        <MaxconnEnable>0</MaxconnEnable>
				        <Maxconn>1000000</Maxconn>
			      </Sla>
			      <Slimit>
				        <CpsMode>1</CpsMode>
				        <Pps>0</Pps>
				        <Bps>0</Bps>
				        <Cps>0</Cps>
				        <CpsEnable>0</CpsEnable>
				        <MaxconnEnable>0</MaxconnEnable>
				        <Maxconn>0</Maxconn>
			      </Slimit>
			      <Synproxy>on</Synproxy>
		    </Config>
		    <FrontendPort>8080</FrontendPort>
		    <Protocol>tcp</Protocol>
	  </NetworkRuleAttributes>
	  <RequestId>F9F2F77D-307C-4F15-8D02-AB5957EEBF97</RequestId>
</DescribeNetworkRuleAttributesResponse>

JSON 格式

{
	"NetworkRuleAttributes": [
		{
			"InstanceId": "ddoscoo-cn-mp91j1ao****",
			"Config": {
				"NodataConn": "off",
				"Cc": {
					"Sblack": []
				},
				"PersistenceTimeout": 0,
				"PayloadLen": {
					"Min": 0,
					"Max": 6000
				},
				"Sla": {
					"Cps": 100000,
					"CpsEnable": 1,
					"MaxconnEnable": 0,
					"Maxconn": 1000000
				},
				"Slimit": {
					"CpsMode": 1,
					"Pps": 0,
					"Bps": 0,
					"Cps": 0,
					"CpsEnable": 0,
					"MaxconnEnable": 0,
					"Maxconn": 0
				},
				"Synproxy": "on"
			},
			"FrontendPort": 8080,
			"Protocol": "tcp"
		}
	],
	"RequestId": "F9F2F77D-307C-4F15-8D02-AB5957EEBF97"
}

错误码

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