You need to enable JavaScript to run this app.
文档中心
私有网络

私有网络

复制全文
下载 pdf
网络ACL
DescribeNetworkAcls - 查询网络ACL列表
复制全文
下载 pdf
DescribeNetworkAcls - 查询网络ACL列表
调用 DescribeNetworkAcls 接口,查询满足指定条件的网络ACL。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:DescribeNetworkAcls​
接口名称。当前 API 的名称为DescribeNetworkAcls。​
​
Version String 必选 示例值:2020-04-01​
接口版本。当前 API 的版本为 2020-04-01。​
​
VpcId String 可选 示例值:vpc-bp1opxu1zkhn00gzv****​
网络ACL所属VPC的ID。​
您可以调用 DescribeVpcs 接口,查询VPC的ID。​
​
NetworkAclIds.N String 可选 示例值:acl-bp1fg655nh68xyz9****​
网络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 可选 示例值:k1​
标签的标签键。​
  • 参数 - N:表示标签键的序号,取值范围:1~10。​
  • 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与(AND)”,即查询同时添加多个标签键的网络ACL。​
  • 不允许重复。​
​
TagFilters.N.Values.N String 可选 示例值: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​
符合条件的网络ACL总数。​
说明​
本参数即将下线,使用NextToken和MaxResults分页查询时,此参数无意义。​
​
PageNumber Integer 示例值:1​
当前页码。​
说明​
本参数即将下线,建议您使用NextToken和MaxResults进行分页查询。​
​
PageSize Integer 示例值:10​
当前分页的行数。​
说明​
本参数即将下线,建议您使用NextToken和MaxResults进行分页查询。​
​
NextToken String 示例值:caeba0bbb2be03f84eb48b699f0a****​
本次API调用返回的查询凭证,标记分页的位置,用于下一次查询。返回为空表示没有下一页。​
​
NetworkAcls Object[] 示例值:-​
网络ACL的详细信息。​
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。​
​
Status String 示例值:Available​
网络ACL的状态。​
  • Available:可用​
  • Creating:创建中​
​
CreationTime String 示例值:2017-12-05T22:40:00+08:00​
创建网络ACL的时间。​
​
UpdateTime String 示例值:2017-12-05T22:40:00+08:00​
修改网络ACL的时间。​
​
ProjectName String 示例值:default​
网络ACL所属项目的名称。​
​
Tags Object[] 示例值:-​
网络ACL的标签信息。​
Key String 示例值:k1​
标签的标签键。​
​
Value String 示例值:v1​
标签的标签值。​
​
​
IngressAclEntries Object[] 示例值:-​
网络ACL入方向规则的信息。​
若存在多条入方向规则,返回结果按照入方向规则的优先级降序进行排序。​
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​
入方向规则源地址的网段。​
​
Protocol String 示例值:all​
协议类型。​
  • tcp:TCP协议。​
  • udp:UDP协议。​
  • icmp:ICMP协议。​
  • icmpv6:ICMPV6协议。​
  • 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 Object[] 示例值:-​
网络ACL出方向规则的详细信息。​
若存在多条出方向规则,返回结果按照入方向规则的优先级降序进行排序。​
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​
目标地址的网段。​
​
Protocol String 示例值:all​
协议类型。​
  • tcp:TCP协议。​
  • udp:UDP协议。​
  • icmp:ICMP协议。​
  • icmpv6:ICMPV6协议。​
  • 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 Object[] 示例值:-​
网络ACL关联资源的详细信息。​
ResourceId String 示例值:subnet-bp1de348lntdwcdf****​
网络ACL关联资源的ID。​
​
Status String 示例值:BINDED​
网络ACL关联资源的状态。​
  • BINDED:已绑定。​
  • BINDING:绑定中。​
  • UNBINDING:解绑中。​
​
​
​
​
​
请求示例​
​
GET /?Action=DescribeNetworkAcls&Version=2020-04-01&VpcId=vpc-bp1opxu1zkhn00gzv****&NextToken=caeba0bbb2be03f84eb48b699f0a****&MaxResults=50 HTTP/1.1​
Host: vpc.cn-beijing.volcengineapi.com​
X-Date: 20250804T033538Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250804/cn-beijing/vpc/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeNetworkAcls",​
"Version": "2020-04-01",​
"Service": "vpc",​
"Region": "cn-beijing"​
},​
"Result": {​
"NetworkAcls": [​
{​
"Tags": [​
{​
"Key": "k1",​
"Value": "v1"​
}​
],​
"VpcId": "vpc-bp67acfmxazb4p****",​
"Status": "Available",​
"AccountId": "2000****",​
"Resources": [​
{​
"Status": "BINDED",​
"ResourceId": "subnet-bp1de348lntdwcdf****"​
}​
],​
"UpdateTime": "2017-12-05T22:40:00+08:00",​
"Description": "TestDescription",​
"ProjectName": "default",​
"CreationTime": "2017-12-05T22:40:00+08:00",​
"NetworkAclId": "nacl-bp1fg655nh68xyz9****",​
"NetworkAclName": "test-acl",​
"EgressAclEntries": [​
{​
"Port": "-1/-1",​
"Policy": "accept",​
"Priority": 1,​
"Protocol": "all",​
"Description": "This is EgressAclEntries.",​
"DestinationCidrIp": "10.XX.XX.0/24",​
"NetworkAclEntryId": "nae-a2d447uw4tillfvgb****",​
"NetworkAclEntryName": "test-acl-1"​
}​
],​
"IngressAclEntries": [​
{​
"Port": "-1/-1",​
"Policy": "accept",​
"Priority": 1,​
"Protocol": "all",​
"Description": "This is IngressAclEntries.",​
"SourceCidrIp": "10.XX.XX.0/24",​
"NetworkAclEntryId": "nae-a2dk86arlydmezasw****",​
"NetworkAclEntryName": "test-acl-1"​
}​
]​
}​
],​
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",​
"RequestId": "2021062415303301022514515207C4****"​
}​
}​
​
错误码​
​
状态码​
错误码​
错误信息​
说明​
400​
DryRunOperation​
Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.​
该请求设置为DryRun操作,操作授权已获得许可,但未被实际执行。​
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.​
已达到单次可指定过滤标签值数量的上限。​
​
​
最近更新时间:2026.08.12 11:42:46
这个页面对您有帮助吗?
有用
有用
无用
无用