DescribeNetworkRules - 查询端口转发规则 - DDoS 防护

查询端口转发规则。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-ddoscoo:DescribeNetworkRules

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	DDoS 高防实例的 ID。说明您可以调用 DescribeInstanceIds 查询所有 DDoS 高防实例的 ID 信息。	ddoscoo-cn-mp91j1ao****
ForwardProtocol	string	否	转发协议。取值： tcp udp	tcp
FrontendPort	integer	否	转发端口。	80
PageNumber	integer	是	分页查询请求时返回的页码。例如，查询第一页的返回结果，则填写 1。	1
PageSize	integer	是	页面显示的记录数量。	10

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	端口转发规则总数。	1
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	8597F235-FA5E-4FC7-BAD9-E4C0B01BC771
NetworkRules	array<object>	端口转发规则信息。
	object
FrontendPort	integer	转发端口。	80
IsAutoCreate	boolean	是否自动创建。取值： true：是 false：否	true
InstanceId	string	DDoS 高防实例 ID。	ddoscoo-cn-mp91j1ao****
Protocol	string	转发协议。取值： tcp udp	tcp
BackendPort	integer	源站端口。	80
RealServers	array	源站 IP 地址列表。
	string	源站 IP 地址。	112.139.XX.XX
Remark	string	端口转发规则的备注信息。	测试
ProxyEnable	integer	引流开关。取值： 0：开启 1：关闭	0
ProxyStatus	string	引流状态。取值： on：引流生效 off：引流失效	on
PayloadRuleEnable	integer	Payload 策略模块开关。取值： 1：开启 0：关闭	1
IpMode	string

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "8597F235-FA5E-4FC7-BAD9-E4C0B01BC771",
  "NetworkRules": [
    {
      "FrontendPort": 80,
      "IsAutoCreate": true,
      "InstanceId": "ddoscoo-cn-mp91j1ao****",
      "Protocol": "tcp",
      "BackendPort": 80,
      "RealServers": [
        "112.139.XX.XX"
      ],
      "Remark": "测试",
      "ProxyEnable": 0,
      "ProxyStatus": "on",
      "PayloadRuleEnable": 1,
      "IpMode": ""
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。