AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云防火墙 云防火墙CFW 开发参考 API参考 API目录 防护配置 访问控制 NAT边界 DescribeNatFirewallControlPolicy - 获取所有NAT防火墙访问控制策略的信息

DescribeNatFirewallControlPolicy - 获取所有NAT防火墙访问控制策略的信息

更新时间：
产品详情
我的收藏

获取所有NAT防火墙访问控制策略的信息。

接口说明

本接口一般用于分页查询 NAT 防火墙访问控制策略的信息。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cloudfirewall:DescribeNatFirewallControlPolicy

list

*NatFirewallControlPolicy

acs:cloudfirewall::{#accountId}:natfirewallcontrolpolicy/{#AclUuid}

 无 无

请求参数

名称

类型

必填

描述

示例值
Lang

string

否

接收消息的语言类型。取值：

  • zh（默认）：中文

  • en：英文

zh
NatGatewayId

string

是

要查询的 NAT 网关的 ID。

ngw-xxxxxx
CurrentPage

string

否

分页查询时，设置当前页的页码。

1
PageSize

string

否

分页查询时，显示的每页数据的最大条数。默认值为 10.

10
Source

string

否

访问控制策略中的访问源地址。支持使用模糊查询的方式进行查询。SourceType（源类型）不同，访问源地址的取值也不同。

  • 当 SourceType 为net时，访问源为 CIDR 格式的 IP 地址段。例如：192.0.XX.XX/24。

  • 当 SourceType 为group时，访问源为源地址簿名称。例如：db_group 为空（表示查询所有访问控制源）。

  • 当 SourceType 为location时，访问源为源区域。例如：北京或 beijing（支持使用中文或英文进行查询）。

说明

不设置该参数表示查询所有类型的访问源。

1.1.1.1/32
Destination

string

否

访问控制策略中的目的地址。支持模糊查询。DestinationType（目的类型）不同，目的地址的取值也不同。

  • 当 DestinationType 为net时，目的地址为 CIDR 格式的 IP 地址段。例如：10.0.3.0/24。

  • 当 DestinationType 为domain时，目的地址为域名。例如：aliyun。

  • 当 DestinationType 为group时，目的地址为地址簿的名称。例如：db_group。

  • 当 DestinationType 为location时，目的地址为区域名称（具体区域位置编码请参见 AddControlPolicy ）。例如：["BJ11", "ZB"]。

说明

不设置该参数表示查询所有类型的目的地址。

x.x.x.x/32
Description

string

否

访问控制策略的描述信息。支持模糊查询。

说明

不设置该参数表示查询所有策略的描述信息。

描述信息
Proto

string

否

访问控制策略中访问流量的协议类型。取值：

  • TCP

  • UDP

  • ICMP

  • ANY（表示所有协议类型）

说明

不设置该参数表示查询所有协议类型。

ANY
AclAction

string

否

安全访问控制策略中访问流量通过云防火墙的方式（动作）。

取值：

  • accept：放行

  • drop：拒绝

  • log：观察

accept
AclUuid

string

否

访问控制策略的唯一标识 ID。

323f0697-2a21-4e43-b142-*****
Release

string

否

访问控制策略的启用状态。策略创建后默认启用该策略。取值：

  • true：启用访问控制策略

  • false：不启用访问控制策略

true
Direction

string

是

访问控制策略控制的流量方向。取值：

  • out：内对外方向的流量访问控制。

out
RepeatType

string

否

访问控制策略的策略有效期的重复类型。取值：

  • Permanent（默认）：总是

  • None：指定单次时间

  • Daily：每天

  • Weekly：每周

  • Monthly：每月

Permanent

返回参数

名称

类型

描述

示例值

object

TotalCount

string

返回结果的总条数。

28
RequestId

string

本次请求的 ID。

F283567D-8A52-5BAE-9472-*****
Policys

array<object>

NAT 防火墙访问控制策略的信息。

object

NAT 防火墙访问控制策略的信息。

Destination

string

访问控制策略中的目的地址。DestinationType（目的类型）不同，目的地址的取值也不同。取值：

  • 当 DestinationType 为 net 时，目的地址为 CIDR 格式的 IP 地址段。例如：192.0.XX.XX/24。

  • 当 DestinationType 为 domain 时，目的地址为域名。例如：aliyuncs.com。

  • 当 DestinationType 为 group 时，目的地址为地址簿的名称。例如：db_group。

  • 当 DestinationType 为 location 时，目的地址为区域名称（具体区域位置编码请参见 AddControlPolicy ）。例如： ["BJ11", "ZB"]。

x.x.x.x/32
Order

integer

访问控制策略生效的优先级。

优先级数字从 1 开始顺序递增，优先级数字越小，优先级越高。

1
DestPortGroup

string

访问控制策略中流量访问的目的端口地址簿名称。

my_port_group
SourceType

string

访问控制策略中的源地址类型。取值：

  • net：源网段（CIDR 地址）

  • group：源地址簿

  • location：源区域

net
DnsResultTime

integer

DNS 解析的时间戳。使用秒级时间戳格式表示。

1579261141
DnsResult

string

DNS 解析结果。

111.0.XX.XX,112.0.XX.XX
ApplicationNameList

array

应用名称，支持多选。

string

应用名称，支持多选。

['HTTP', 'HTTPS']
AclUuid

string

访问控制策略的唯一标识 ID。

01281255-d220-4db1-8f4f-c4df221a****
DestPortType

string

访问控制策略中流量访问的目的端口类型。取值：

  • port：端口

  • group：端口地址簿

port
Source

string

访问控制策略中的访问源地址。取值：

  • 当 SourceType 为net时，访问源为 CIDR 格式的 IP 地址段。例如：192.0.XX.XX/24。

  • 当 SourceType 为group时，访问源地址为源地址簿名称。例如：db_group。

  • 当 SourceType 为location时，访问源地址为区域（具体区域位置编码请参见 AddControlPolicy ）。例如： ["BJ11", "ZB"]。

192.0.XX.XX/24
DestinationType

string

访问控制策略中的目的地址类型。取值：

  • net：目的网段（CIDR）

  • group：目的地址簿

  • domain：目的域名

  • location：目的区域

net
HitTimes

integer

访问控制策略的命中次数。

100
HitLastTime

integer

最新命中时间戳。使用秒级时间戳格式表示。

1579261141
DestPort

string

访问控制策略中访问流量的目的端口。

80
Description

string

访问控制策略的描述信息。

描述信息
AclAction

string

访问控制策略中设置的流量通过云防火墙的方式（动作）。取值：

  • accept：放行

  • drop：拒绝

  • log：观察

accept
Proto

string

访问控制策略中流量访问的安全协议类型。取值：

  • ANY

  • TCP

  • UDP

  • ICMP

TCP
DestinationGroupCidrs

array

访问控制策略中的目的地址簿中的网段列表。

string

访问控制策略中的目的地址簿中的网段列表。

[ "112.0.XX.XX/24", "112.0.XX.XX/32" ]
DestPortGroupPorts

array

目的端口地址簿中包含的端口列表。

string

目的端口地址簿中包含的端口列表。

[80,443]
SourceGroupCidrs

array

访问控制策略中的源地址簿中的网段列表。

string

访问控制策略中的源地址簿中的网段列表。

['192.0.XX.XX/24', '192.0.XX.XX/32']
Release

string

访问控制策略的启用状态。策略创建后默认启用该策略。取值：

  • true：启用访问控制策略

  • false：不启用访问控制策略

true
SourceGroupType

string

访问控制策略中的源地址簿类型。唯一取值： ip。表示 IP 地址簿，包含一个或多个 IP 地址段。

ip
DestinationGroupType

string

访问控制策略中的目的地址簿类型。取值：

  • ip：IP 地址簿，包含一个或多个 IP 地址段。

  • domain：域名地址簿，包含一个或多个域名地址。

ip
NatGatewayId

string

要查询的 NAT 网关的 ID。

ngw-xxxxxx
DomainResolveType

integer

访问控制策略的域名解析方式。策略创建后默认启用该策略。取值：

  • 0：基于 FQDN

  • 1：基于 DNS 动态解析

  • 2：基于 FQDN 与 DNS 动态解析

0
SpreadCnt

string

占用访问控制策略的规格数，即每条策略占用规格数的累加值。 单条策略占用访问控制策略的规格数=访问源地址段个数 * 目的地址个数（IP 地址段个数或区域个数或域名个数）* 应用数 * 端口段个数。

10,000
CreateTime

integer

创建策略的时间。

1761062400
ModifyTime

integer

修改策略的时间。

1761062400
RepeatType

string

访问控制策略的策略有效期的重复类型。取值：

  • Permanent（默认）：总是

  • None：指定单次时间

  • Daily：每天

  • Weekly：每周

  • Monthly：每月

Permanent
RepeatDays

array

访问控制策略的策略有效期的重复日期集合。

  • 当 RepeatType 为Permanent、None、Daily时，RepeatDays 为空集合。 例如：[]

  • 当 RepeatType 为 Weekly 时，RepeatDays 不能为空。 例如：[0, 6]

说明

RepeatType 设置为 Weekly 时，RepeatDays 不允许重复。

  • 当 RepeatType 为Monthly时，RepeatDays 不能为空。 例如：[1, 31]

说明

RepeatType 设置为 Monthly 时，RepeatDays 不允许重复。

integer

访问控制策略的策略有效期的重复日期。

说明

RepeatType 设置为 Weekly 时，取值范围：0~6，每周开始于周日。 RepeatType 设置为 Monthly 时，取值范围：1~31。

1
RepeatStartTime

string

访问控制策略的策略有效期的重复开始时间。例如：08:00，必须为整点或半点时间，且小于重复结束时间至少半小时。

说明

当 RepeatType 为 Permanent、None 时，RepeatStartTime 为空。当 RepeatType 为 Daily、Weekly、Monthly 时，RepeatStartTime 必须有值，您需要设置重复开始时间。

08:00
RepeatEndTime

string

访问控制策略的策略有效期的重复结束时间。例如：23:30，必须为整点或半点时间，且大于重复开始时间至少半小时。

说明

当 RepeatType 为 Permanent、None 时，RepeatEndTime 为空。当 RepeatType 为 Daily、Weekly、Monthly 时，RepeatEndTime 必须有值，您需要设置重复结束时间。

23:30
StartTime

integer

访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间，且小于结束时间至少半小时。

说明

当 RepeatType 为 Permanent 时，StartTime 为空。当 RepeatType 为 None、Daily、Weekly、Monthly 时，StartTime 必须有值，您需要设置开始时间。

1694761200
EndTime

integer

访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间，且大于开始时间至少半小时。

说明

当 RepeatType 为 Permanent 时，EndTime 为空。当 RepeatType 为 None、Daily、Weekly、Monthly 时，EndTime 必须有值，您需要设置结束时间。

1694764800

示例

正常返回示例

JSON格式

{
  "TotalCount": "28",
  "RequestId": "F283567D-8A52-5BAE-9472-*****",
  "Policys": [
    {
      "Destination": "x.x.x.x/32",
      "Order": 1,
      "DestPortGroup": "my_port_group",
      "SourceType": "net",
      "DnsResultTime": 1579261141,
      "DnsResult": "111.0.XX.XX,112.0.XX.XX",
      "ApplicationNameList": [
        "['HTTP', 'HTTPS']"
      ],
      "AclUuid": "01281255-d220-4db1-8f4f-c4df221a****",
      "DestPortType": "port",
      "Source": "192.0.XX.XX/24",
      "DestinationType": "net",
      "HitTimes": 100,
      "HitLastTime": 1579261141,
      "DestPort": "80",
      "Description": "描述信息",
      "AclAction": "accept",
      "Proto": "TCP",
      "DestinationGroupCidrs": [
        "[\n      \"112.0.XX.XX/24\",\n      \"112.0.XX.XX/32\"\n]"
      ],
      "DestPortGroupPorts": [
        "[80,443]"
      ],
      "SourceGroupCidrs": [
        "['192.0.XX.XX/24', '192.0.XX.XX/32']"
      ],
      "Release": "true",
      "SourceGroupType": "ip",
      "DestinationGroupType": "ip",
      "NatGatewayId": "ngw-xxxxxx",
      "DomainResolveType": 0,
      "SpreadCnt": "10,000",
      "CreateTime": 1761062400,
      "ModifyTime": 1761062400,
      "RepeatType": "Permanent",
      "RepeatDays": [
        1
      ],
      "RepeatStartTime": "08:00",
      "RepeatEndTime": "23:30",
      "StartTime": 1694761200,
      "EndTime": 1694764800
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述
400 ErrorParametersUid The aliUid parameter is invalid. aliUid 不合法
400 ErrorParametersPageSizeOrNo Either pageSize or pageNo is invalid. 无效的pageSize或者pageNo
400 ErrorParameterIpVersion The IP version is invalid. IP版本参数错误
400 ErrorParametersDirection The direction is invalid. 无效的方向
400 ErrorDBSelect An error occurred while querying database. 内部错误：数据库查询错误
400 ErrorUnmarshalJSON An error occurred while parsing JSON. 内部错误：JSON解码错误
400 ErrorParametersAppId The AppId parameter is incorrect. AppId不正确
400 ErrorParametersNatGatewayId Invalid parameters NatGatewayId. 请求参数NatGatewayId不合法或不存在。
400 ErrorUUIDNew The UUID is invalid. 内部错误：UUID错误
400 ErrorParametersSource The source is invalid. 无效的来源
400 ErrorDomainResolve An error occurred while resolving the domain. 域名解析错误
400 ErrorParametersDestination The Destination parameter is invalid. Destination参数非法
400 ErrorParametersProto The protocol is invalid. 无效的协议
400 ErrorParametersDestPort The dst_port is invalid. 无效的目的端口
400 ErrorParametersAction The action is invalid. 无效的动作
400 ErrorMarshalJSON An error occurred while encoding JSON. 内部错误：JSON编码错误
400 ErrorParametersAclUuid Specified parameter AclUuid is not valid. 指定的ACL uuid不合法。

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

变更历史

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

上一篇：DescribeNatAclPageStatus - 查询NAT防火墙分页状态下一篇：DescribeNatFirewallPolicyPriorUsed - 查询NAT防火墙访问控制策略优先级使用范围