调用此接口，通过策略方向和 NAT 实例 ID，可以查询实例下该方向的访问控制策略列表详情。

请求说明

请求方式：POST

请求地址：https://fw-center.volcengineapi.com/?Action=DescribeNatFirewallControlPolicy&Version=2021-09-06

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	DescribeNatFirewallControlPolicy	接口名称。当前 API 的名称为 DescribeNatFirewallControlPolicy。
Version	String	是	2021-09-06	接口版本。当前 API 的版本为 2021-09-06。

Body

参数	类型	是否必选	示例值	描述
Action	Array of String	否	accept	策略动作，精确匹配。 accept：放行 deny：阻断 monitor：观察
Description	String	否	允许来自 180...1/32 的 TCP 80 端口访问	策略描述信息，支持模糊匹配查询。
DestPort	Array of String	否	["80","443"]	目的端口，用于精确匹配查询条件。支持多个端口值进行查询。
Destination	Array of String	否	["180...*"]	目的地址，用于模糊匹配查询条件。支持多个地址值进行查询。
Direction	String	是	in	策略方向，用于指定访问控制策略的应用方向。 in：入方向； out：出方向。
NatFirewallId	String	是	nfw-********	NAT 边界防火墙实例 ID。获取方式可参考DescribeNatFirewallList - 查询NAT边界防火墙实例列表。
OrderDir	String	否	desc	按优先级排序，支持的取值如下所示。 asc：升序，即优先级字段从小到大，优先级顺序从高到低 desc：降序，即优先级字段从大到小，优先级顺序从低到高
PageNumber	Integer	否	1	分页页码，默认值为 1。
PageSize	Integer	否	10	分页大小，默认值为 10。
Proto	Array of String	否	["TCP","UDP"]	协议类型，用于精确匹配查询条件。支持以下协议类型： ICMP TCP UDP ANY（任何协议）
RepeatType	Array of String	否	Once	策略的重复类型，用于精确匹配查询条件。支持以下类型： Permanent：始终生效； Once：单次生效； Daily：每日重复； Weekly：每周重复； Monthly：每月重复。
RuleId	Array of String	否	f04ac7ce-**---**********	访问控制策略唯一标识 ID。获取方式可参考DescribeNatFirewallControlPolicy - 查询 NAT 边界防火墙访问控制策略列表。
Source	Array of String	否	["180...1/32"]	源地址，用于模糊匹配查询条件。支持多个地址值进行查询。
Status	Array of Boolean	否	true	策略启用状态，精确匹配。 true：开启； false：关闭。
IsEffect	Array of Boolean	否	[true]	策略是否生效，精确匹配。 true：生效； false：不生效。

返回参数

参数	类型	示例值	描述
Count	Integer	10	返回数据的实际数量，表示当前页面返回的 NAT 边界防火墙访问控制策略数量。当查询数据为空且使用 Python SDK 调用时，此项为 None。
Data	Array of DescribeControlPolicyDetailV1	--	策略详情。
PageNumber	Integer	1	返回数据的分页页码，表示当前查询结果所在的页码。
PageSize	Integer	10	返回数据的分页大小，表示每页显示的 NAT 边界防火墙访问控制策略数量。
TotalCount	Integer	14	返回的策略总量，表示符合查询条件的 NAT 边界防火墙访问控制策略总数。当查询数据为空且使用 Python SDK 调用时，此项为 None。

DescribeControlPolicyDetailV1

参数	类型	示例值	描述
Prio	Integer	1	规则优先级，数值越小优先级越高。
Proto	String	TCP	规则协议，表示访问控制策略所适用的网络协议类型。
Action	String	deny	规则动作
HitCnt	Integer	70	规则命中次数，表示该访问控制策略被匹配并执行的次数。
IpType	String	v4	IP 地址的类型，取值如下所示。 v4：IPv4 地址； v6：IPv6 地址。
RuleId	String	f04ac7ce-628b-4cb7-be61-310222b7****	访问控制策略的唯一标识，用于唯一区分不同的 NAT 边界防火墙访问控制策略。
Source	String	180...1/32	源地址，根据 SourceType 的不同取值有不同的格式要求。当 SourceType 为 net 时，格式为源 CIDR 地址，例如：180...1/32；当 SourceType 为 group 时，格式为源地址簿的 UUID 列表，最多支持 50 个地址簿，多个地址簿用英文逗号分隔，例如：`f04ac7ce----********；当 SourceType 为 location 时，格式为源区域代码，多个地域用英文逗号分隔，例如：BJ11, ZB。
Status	Boolean	true	访问控制策略的开关状态，默认值为 false（关闭）。 true：开启； false：关闭。
EndTime	Integer	1727247865	策略生效截止日期，Unix 时间戳。
DestPort	String	832a5162-5949-4953-b789-********	目的端口，格式为单个端口 22 或端口范围 100/200。当协议类型为 ICMP 或 ALL 时，该字段为空；当 DestPortType 为 group 时，该字段为端口地址簿的 UUID 列表，多个地址簿通过英文逗号分隔；当 DestPortType 为 port时，该字段为端口范围。
UseCount	Integer	1	使用策略数，表示当前访问控制策略被引用的次数。
AccountId	String	2100052276	账号的唯一标识符，用于区分不同的云服务账号。
Direction	String	out	规则的方向，表示访问控制策略的流量方向。 out：出方向； in：入方向。
StartTime	Integer	1727247865	策略生效起始日期，Unix 时间戳。
FirewallId	String	nfw-12345678	防火墙实例的唯一标识符。
IsEffected	Boolean	true	表示访问控制策略是否生效的状态。 true：已生效； false：未生效。
RepeatDays	Array of Integer	[1,3,5]	策略重复生效的日期列表，表示该访问控制策略在每周的哪些天生效。日期范围为 1（周一）至 7（周日）。
RepeatType	String	Permanent	重复类型，用于指定策略生效的时间周期。 Permanent：始终生效； Once：单次生效； Daily：每日重复； Weekly：每周重复； Monthly：每月重复。
SourceType	String	group	源地址的类型，用于指定访问控制策略中源地址的格式和来源。 net：表示源地址为 CIDR 格式的 IP 地址段； group：表示源地址为地址簿的 UUID 列表； location：表示源地址为地域代码。
UpdateTime	Integer	1714298363	访问控制策略的最后更新时间，以 Unix 时间戳格式表示。该字段记录了策略配置或状态变更的具体时间点。
Description	String	http deny	访问控制策略的描述信息，用于记录该策略的用途、备注或其他相关信息。
Destination	String	192.1.1.1	目的地址，根据 DestinationType 的不同取值有不同的格式要求。当 DestinationType 为 group 时，格式为目的地址簿的 UUID 列表，多个地址簿用英文逗号分隔；当 DestinationType 为 net 时，格式为目的 CIDR地址。
LastHitTime	Integer	1703157199	表示该访问控制策略上次被匹配并执行的具体时间点，以 Unix 时间戳格式记录。该字段可用于分析策略的使用频率和活跃程度。
DestPortList	Array of String	["80","443","8080/8090"]	目的端口列表，表示访问控制策略中配置的目的端口集合。支持单个端口（如 22）或端口范围（如 100/200）的格式。
DestPortType	String	group	目的端口类型，用于指定访问控制策略中目的端口的格式和来源。 group：表示目的端口为端口地址簿的 UUID 列表； port：表示目的端口为端口范围。
EffectStatus	Integer	3	访问控制策略的生效状态，取值如下所示。 1：未生效； 2：下发中； 3：已生效。
RepeatEndTime	String	2024-09-10 12:00	策略重复生效的结束时间，格式为 YYYY-MM-DD HH:MM。该字段与 RepeatStartTime共同定义策略生效的时间窗口。
DestPortListV1	Array of AddressStructureResp	-	目的端口列表，包含端口类型、具体地址和描述信息。
SourceCidrList	Array of String	["192.168.0.1/24","10.0.0.1/32"]	访问控制策略的源地址列表，表示该策略适用的源 IP 地址或地址段。当 SourceType 为 net 时，列表中每个元素表示一个 CIDR 格式的 IP 地址段；当 SourceType 为 group 时，列表中每个元素表示一个源地址簿的 UUID。
DestinationType	String	net	目的地址的类型，用于指定访问控制策略中目的地址的格式和来源。 group：表示目的地址为地址簿的 UUID 列表； net：表示目的地址为 CIDR 格式的 IP地址段。
RepeatStartTime	String	2024-09-10 11:00	策略重复生效的开始时间，格式为 YYYY-MM-DD HH:MM。该字段与 RepeatEndTime共同定义策略生效的时间窗口。
SourceGroupList	Array of String	["address-book-1","address-book-2"]	源地址组列表，表示访问控制策略中配置的源地址组集合。每个元素代表一个地址组的标识符，用于引用预定义的地址组。
SourceGroupType	String	ip	源地址组的类型，用于指定访问控制策略中源地址组的格式和来源。 ip：引用地址簿为空：未引用地址簿
SourceCidrListV1	Array of AddressStructureResp	-	源地址列表，包含地址类型、具体地址和描述信息。
DestPortGroupList	Array of String	["port-group-1","port-group-2"]	目的端口组列表，表示访问控制策略中配置的目的端口组集合。每个元素代表一个端口组的标识符，用于引用预定义的端口组。
DestPortGroupType	String	port	目的端口组的类型，用于指定访问控制策略中目的端口组的格式和来源。 port：引用端口地址簿；为空：未引用端口地址簿。
DestinationCidrList	Array of String	["10.0.0.0/24","192.168.1.0/28"]	目的地址列表，表示访问控制策略中配置的目的 IP 地址集合，用于精确匹配目的网络范围。
DestinationGroupList	Array of String	["address-book-1","address-book-2"]	目的地址组列表，表示访问控制策略中配置的目的地址组集合。每个元素代表一个地址组的标识符，用于引用预定义的地址组。
DestinationGroupType	String	ip	目的地址组的类型，用于指定访问控制策略中目的地址组的格式和来源。 ip：引用地址簿为空：未引用地址簿
DestinationCidrListV1	Array of AddressStructureResp	-	目的地址列表，包含地址类型、具体地址和描述信息。
DestinationDomainList	Array of String	["example.com","test.example.org"]	目的域名列表，表示访问控制策略中配置的目的域名集合，用于匹配目标网络流量中的域名请求。

AddressStructureResp

参数	类型	示例值	描述
Type	String	port	地址类型，支持的取值如下所示。 ip：IPv4 地址； ipv6：IPv6 地址； domain：域名； port：端口。
Address	String	22/22	具体地址值，其格式取决于 GroupType 的取值：当GroupTyp为ip时，对应 IPv4 地址或 CIDRv4 信息；当GroupTyp为ipv6时，对应 IPv6 地址或 CIDRv6 信息；当GroupTyp为port时，对应端口信息；当GroupTyp为domain时，对应域名信息。
Description	String	允许 SSH 访问	描述信息，用于记录相关用途、备注或其他相关信息。

请求示例

返回示例

错误码

您可访问公共错误码，获取更多错误码信息。

云防火墙