DescribeNetworkAcls--私有网络-火山引擎

文档中心

立即注册

导航

DescribeNetworkAcls

最近更新时间：2024.09.06 08:11:09首次发布时间：2022.04.28 07:34:09

调用 DescribeNetworkAcls 接口，查询满足指定条件的网络ACL。

调试

API Explorer

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

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeNetworkAcls	要执行的操作。取值：DescribeNetworkAcls。
Version	String	是	2020-04-01	API版本信息，取值为：2020-04-01。
VpcId	String	否	vpc-bp1opxu1zkhn00gzv****	网络ACL所属VPC的ID。您可以调用 DescribeVpcs 接口，查询VPC的ID。
NetworkAclIds.N	String	否	NetworkAclIds.1=acl-bp1fg655nh68xyz9**&NetworkAclIds.2=acl-p9ew1fgyb35nh0z**	网络ACL的ID。参数 - N：表示网络ACL的ID序号，单次调用数量上限100个。多个ID之间用&分隔。
SubnetId	String	否	subnet-087k1y0owv0x57ku****	网络ACL关联的子网的ID。您可以调用 DescribeSubnets 接口，查询子网的ID。
NetworkAclName	String	否	test-acl	网络ACL的名称。
ProjectName	String	否	default	网络ACL所属的项目。
TagFilters.N.Key	String	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3	标签的标签键。参数 - N：表示标签键的序号，取值范围：1～10。多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的网络ACL。不允许重复。
TagFilters.N.Values.N	String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=v1	标签的标签值。第一个N：表示标签键的序号，取值范围：1～10。第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的网络ACL。多个标签值之间用&分隔。说明若传入该参数，则必须先传入`TagFilters.N.Key`。传入空字符串时，表示查询标签值为空的网络ACL。
PageNumber	Integer	否	1	列表的页码。默认值为1。说明本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。
PageSize	Integer	否	20	分页查询时每页的行数。最大值为100，默认值为20。说明本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。
NextToken	String	否	caeba0bbb2be03f84eb48b699f0a****	分页查询凭证，用于标记分页的位置。不填则从头开始查询。传入之前调用本API返回的`NextToken`，则从该次API调用标记分页的位置往后开始查询。
MaxResults	Integer	否	50	查询的数量，默认为 10，最大为100。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。
TotalCount	Integer	2	符合条件的VPC总数。说明本参数即将下线，使用`NextToken`和`MaxResults`分页查询时，此参数无意义。
PageNumber	Integer	1	当前页码。说明本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。
PageSize	Integer	10	当前分页的行数。说明本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。
NextToken	String	caeba0bbb2be03f84eb48b699f0a****	本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。
NetworkAcls	Array of Struct	-	网络ACL的详细信息。具体请见下表“NetworkAcls结构”。

NetworkAcls结构

参数名称	类型	示例值	描述
AccountId	String	2000****	网络ACL所属的主账号ID。
NetworkAclId	String	nacl-bp1fg655nh68xyz9****	网络ACL的ID。
NetworkAclName	String	test-acl	网络ACL名称。
Description	String	TestDescription	网络ACL描述信息。
VpcId	String	vpc-bp67acfmxazb4p****	网络ACL所属的VPC。
IngressAclEntries	Array of Struct	-	网络ACL入方向规则的信息。入方向规则的详细信息请参见下表“IngressAclEntries结构”。若存在多条入方向规则，返回结果按照入方向规则的优先级降序进行排序。
EgressAclEntries	Array of Struct	-	网络ACL出方向规则的详细信息。出方向规则的详细信息请参见下表“EgressAclEntries结构”。若存在多条出方向规则，返回结果按照入方向规则的优先级降序进行排序。
Resources	Array of Struct	-	网络ACL关联资源的详细信息。具体请参见下表“Resources结构”。
Status	String	Available	网络ACL的状态。 Available：可用 Creating：创建中
ProjectName	String	default	网络ACL所属项目的名称。
Tags	Array of Struct	-	网络ACL的标签信息。具体请参见下表“Tag结构”。
CreationTime	String	2017-12-05T22:40:00+08:00	创建网络ACL的时间。
UpdateTime	String	2017-12-05T22:40:00+08:00	更新网络ACL的时间。

IngressAclEntries结构

参数名称	类型	示例值	描述
NetworkAclEntryId	String	nae-a2dk86arlydmezasw****	入方向规则的ID。
NetworkAclEntryName	String	test-acl-1	入方向规则的名称。
Description	String	This is IngressAclEntries.	入方向规则的描述信息。
Policy	String	accept	入方向规则的授权策略。 accept：允许访问。 drop：拒绝访问。不返回拒绝访问的信息，仅表现出发起端请求超时或类似无法建立连接的信息。
SourceCidrIp	String	10.XX.XX.0/24	源地址的网段。支持CIDR格式和IPv4格式的IP地址范围。默认值：无
Protocol	String	all	协议类型。 tcp：TCP协议。 udp：UDP协议。 icmp：ICMP协议。 icmpv6：ICMPV6协议。说明 IPv6功能正在邀测中，暂仅支持完成企业认证的账号申请试用，如需试用，请联系客户经理。 gre：GRE协议。 all：支持所有协议。
Priority	integer	1	入方向规则的优先级，数字越小，代表优先级越高。取值范围：1 ~ 100 不填默认值：1
Port	String	-1/-1	入方向规则的目的端口范围。当入方向规则的`Protocol`为`all`、`icmp`或`gre`时，端口范围为-1/-1，表示不限制端口。当入方向规则的`Protocol`为`tcp`或`udp`时，端口范围为1~65535，格式为1/200、80/80，表示端口1到端口200、端口80。

EgressAclEntries结构

参数名称	类型	示例值	描述
NetworkAclEntryId	String	nae-a2d447uw4tillfvgb****	出方向规则的ID。
NetworkAclEntryName	String	test-acl-1	出方向规则的名称。
Description	String	This is EgressAclEntries.	出方向规则的描述信息。
Policy	String	accept	授权策略。 accept：允许访问。 drop：拒绝访问。不返回拒绝访问的信息，仅表现出发起端请求超时或类似无法建立连接的信息。
DestinationCidrIp	String	10.XX.XX.0/24	目标地址的网段。支持CIDR格式和IPv4格式的IP地址范围。默认值：无
Protocol	String	all	协议类型。 tcp：TCP协议。 udp：UDP协议。 icmp：ICMP协议。 icmpv6：ICMPV6协议。说明 IPv6功能正在邀测中，暂仅支持完成企业认证的账号申请试用，如需试用，请联系客户经理。 gre：GRE协议。 all：支持所有协议。
Priority	integer	1	出方向规则的优先级，数字越小，代表优先级越高。取值范围：1 ~ 100 不填默认值：1
Port	String	-1/-1	出方向规则的目的端口范围。当出方向规则的`Protocol`为`all`、`icmp`或`gre`时，端口范围为-1/-1，表示不限制端口。当出方向规则的`Protocol`为`tcp`或`udp`时，端口范围为1~65535，格式为1/200、80/80，表示端口1到端口200、端口80。

Resources结构

参数名称	类型	示例值	描述
ResourceId	String	subnet-bp1de348lntdwcdf****	网络ACL关联资源的ID。
Status	String	BINDED	网络ACL关联资源的状态。 BINDED：已绑定。 BINDING：绑定中。 UNBINDING：解绑中。

参数名称

类型

示例值

描述

ResourceId

String

subnet-bp1de348lntdwcdf****

网络ACL关联资源的ID。

Status

String

BINDED

网络ACL关联资源的状态。

BINDED：已绑定。
BINDING：绑定中。
UNBINDING：解绑中。

Tag结构

参数名称	类型	示例值	描述
Key	String	k1	标签的标签键。
Value	String	v1	标签的标签值。

请求示例

GET /?Action=DescribeNetworkAcls&Version=2020-04-01&VpcId=vpc-bp1opxu1zkhn00gzv****PageNumber=1&PageSize=20 HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106241530330102251****",
        "Action": "DescribeNetworkAcls",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "TotalCount": 2,
        "PageNumber": 1,
        "PageSize": 20,
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "NetworkAcls": [
            {
                "AccountId": "2000****",
                "NetworkAclId": "nacl-bp1fg655nh68xyz9****",
                "NetworkAclName": "test-acl",
                "Description": "TestDescription",
                "VpcId": "vpc-bp67acfmxazb4p****",
                "IngressAclEntries": [
                    {
                        "NetworkAclEntryId": "nae-a2dk86arlydmezasw****",
                        "NetworkAclEntryName": "test-acl-1",
                        "Description": "This is IngressAclEntries.",
                        "Policy": "accept",
                        "SourceCidrIp": "10.XX.XX.0/24",
                        "Protocol": "all",
                        "Priority": 1,
                        "Port": "-1/-1"
                    }
                ],
                "EgressAclEntries": [
                    {
                        "NetworkAclEntryId": "nae-a2d447uw4tillfvgb****",
                        "NetworkAclEntryName": "test-acl-1",
                        "Description": "This is EgressAclEntries.",
                        "Policy": "accept",
                        "DestinationCidrIp": "10.XX.XX.0/24",
                        "Protocol": "all",
                        "Priority": 1,
                        "Port": "-1/-1"
                    }
                ],
                "Resources": [
                    {
                        "Status": "BINDED",
                        "ResourceId": "subnet-bp1de348lntdwcdf****"
                    }
                ],
                "Status": "Available",
                "ProjectName": "default",
                "Tags": [
                    {
                        "Key":"k1",
                        "Value":"v1"
                    }
                 ],     
                "CreationTime": "2017-12-05T22:40:00+08:00",
                "UpdateTime": "2017-12-05T22:40:00+08:00"                         
            }
        ]
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	InvalidMaxResults.Malformed	The specified parameter MaxResults is malformed.	查询数量不合法。
400	InvalidNextToken.Malformed	The specified parameter NextToken is invalid.	查询 NextToken 不合法。
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	指定标签过滤项的索引顺序参数格式不合法。
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	过滤标签键不合法。
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	过滤标签值不合法。
400	LimitExceeded.NetworkAcl	You've reached the limit on the number of Network ACL IDs that you can describe.	已达到可查询的网络ACL的ID数量上限。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValue	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签值数量的上限。