文档

DescribeNetworkAcls - 查看网络ACL列表

更新时间:

调用DescribeNetworkAcls接口查看网络ACL列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeNetworkAclsList
  • NetworkAcl
    acs:vpc:{#regionId}:{#accountId}:networkacl/*

请求参数

名称类型必填描述示例值
NetworkAclIdstring

网络 ACL 的 ID。

nacl-bp1lhl0taikrbgnh****
NetworkAclNamestring

网络 ACL 的名称。

名称长度为 1~128 个字符,不能以http://https://开头。

acl-1
VpcIdstring

网络 ACL 关联的 VPC 的 ID。

vpc-m5ebpc2xh64mqm27e****
ResourceTypestring

关联实例的类型。取值:VSwitch,交换机。

ResourceTypeResourceId 参数需要同时指定才生效。

VSwitch
ResourceIdstring

关联实例的 ID。

vsw-bp1de348lntdwnhbg****
PageNumberinteger

列表的页码。默认值:1

1
PageSizeinteger

分页查询时每页的行数。最大值:50。默认值:10

10
RegionIdstring

网络 ACL 所属的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
Tagsobject []

标签列表。

Keystring

资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655440000

返回参数

名称类型描述示例值
object
PageSizestring

分页查询时每页的行数。

10
RequestIdstring

请求 ID。

F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1
PageNumberstring

列表的页码。

1
TotalCountstring

列表条目数。

2
NetworkAclsobject []

网络 ACL 的详细信息。

Statusstring

网络 ACL 的状态。取值:

  • Available:可用。

  • Modifying:配置中。

Available
VpcIdstring

关联的 VPC 的 ID。

vpc-m5ebpc2xh64mqm27e****
CreationTimestring

网络 ACL 的创建时间。

2021-12-25 11:44:17
Descriptionstring

网络 ACL 的描述信息。

This is my NetworkAcl.
NetworkAclNamestring

网络 ACL 的名称。

acl-1
NetworkAclIdstring

网络 ACL 的 ID。

nacl-a2do9e413e0spxscd****
OwnerIdlong

网络 ACL 所属阿里云账号 ID。

253460731706911258
RegionIdstring

网络 ACL 所属的地域 ID。

cn-hangzhou
IngressAclEntriesobject []

入方向规则信息。

NetworkAclEntryIdstring

入方向规则条目的 ID。

nae-a2dk86arlydmezasw****
EntryTypestring

规则类型,取值为 custom,表示自定义。

custom
NetworkAclEntryNamestring

入方向规则条目的名称。

acl-3
Policystring

授权策略,取值:

  • accept:允许。

  • drop:拒绝。

accept
Descriptionstring

入方向规则的描述信息。

This is IngressAclEntries.
SourceCidrIpstring

源地址段。

10.0.0.0/24
IpVersionstring

BGP 组的 IP 版本。取值:

  • IPv4:IPv4 版本。
  • IPv6:IPv6 版本。
IPv4
Protocolstring

协议类型,取值:

  • icmp:网络控制报文协议。

  • gre:通用路由封装协议。

  • tcp:传输控制协议。

  • udp:用户数据报协议。

  • all:支持所有协议。

all
Portstring

入方向规则的目的端口范围。

  • 当入方向规则的 Protocol(协议类型)为 allicmpgre 时,端口范围为-1/-1,表示不限制端口。
  • 当入方向规则的 Protocol(协议类型)为 tcpudp 时,端口范围为 1~65535,格式为1/20080/80,表示端口 1 到端口 200 或端口 80。
-1/-1
EgressAclEntriesobject []

出方向规则信息。

NetworkAclEntryIdstring

出方向规则条目的 ID。

nae-a2d447uw4tillfvgb****
EntryTypestring

规则类型,取值为 custom,表示自定义。

custom
NetworkAclEntryNamestring

出方向规则条目的名称。

acl-2
Policystring

授权策略,取值:

  • accept:允许。

  • drop:拒绝。

accept
Descriptionstring

出方向规则的描述信息。

This is EgressAclEntries.
Protocolstring

协议类型,取值:

  • icmp:网络控制报文协议。

  • gre:通用路由封装协议。

  • tcp:传输控制协议。

  • udp:用户数据报协议。

  • all:支持所有协议。

all
DestinationCidrIpstring

目标地址段。

10.0.0.0/24
IpVersionstring

实例的 IP 协议版本。取值:

  • Ipv4: IPv4 版本。
  • Ipv6: IPv6 版本。
IPV4
Portstring

出方向规则的目的端口范围。

  • 当出方向规则的 Protocol(协议类型)为 allicmpgre 时,端口范围为-1/-1,表示不限制端口。
  • 当出方向规则的 Protocol(协议类型)为 tcpudp 时,端口范围为 1~65535,格式为1/20080/80,表示端口 1 到端口 200 或端口 80。
-1/-1
Resourcesobject []

关联的资源。

Statusstring

关联资源的状态。取值:

  • BINDED:已绑定。

  • BINDING:绑定中。

  • UNBINDING:已解绑。

BINDED
ResourceTypestring

关联资源的类型。

VSwitch
ResourceIdstring

关联资源的 ID。

vsw-bp1de348lntdwcdf****
Tagsobject []

标签列表信息。

Keystring

标签键。

FinanceDept
Valuestring

标签值。

FinanceJoshua

示例

正常返回示例

JSON格式

{
  "PageSize": "10",
  "RequestId": "F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1",
  "PageNumber": "1",
  "TotalCount": "2",
  "NetworkAcls": {
    "NetworkAcl": [
      {
        "Status": "Available",
        "VpcId": "vpc-m5ebpc2xh64mqm27e****",
        "CreationTime": "2021-12-25 11:44:17",
        "Description": "This is my NetworkAcl.",
        "NetworkAclName": "acl-1",
        "NetworkAclId": "nacl-a2do9e413e0spxscd****",
        "OwnerId": 253460731706911260,
        "RegionId": "cn-hangzhou",
        "IngressAclEntries": {
          "IngressAclEntry": [
            {
              "NetworkAclEntryId": "nae-a2dk86arlydmezasw****",
              "EntryType": "custom",
              "NetworkAclEntryName": "acl-3\t",
              "Policy": "accept",
              "Description": "This is IngressAclEntries.",
              "SourceCidrIp": "10.0.0.0/24\t",
              "IpVersion": "IPv4",
              "Protocol": "all",
              "Port": "-1/-1\t"
            }
          ]
        },
        "EgressAclEntries": {
          "EgressAclEntry": [
            {
              "NetworkAclEntryId": "nae-a2d447uw4tillfvgb****",
              "EntryType": "custom",
              "NetworkAclEntryName": "acl-2\t",
              "Policy": "accept",
              "Description": "This is EgressAclEntries.",
              "Protocol": "all",
              "DestinationCidrIp": "10.0.0.0/24\t",
              "IpVersion": "IPV4",
              "Port": "-1/-1\t"
            }
          ]
        },
        "Resources": {
          "Resource": [
            {
              "Status": "BINDED",
              "ResourceType": "VSwitch",
              "ResourceId": "vsw-bp1de348lntdwcdf****"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400ParameterMissing.AliUidParameterMissing.AliUid-
400ParameterMissing.BidParameterMissing.Bid-
400ParameterMissing.RegionIdParameterMissing.RegionId-
400ParameterEmpty.RegionIdParameterEmpty.RegionId-
400NotSupport.NetworkAclNetwork acl is not support now.-
500InternalErrorThe request processing has failed due to some unknown error.请求处理由于某些未知错误失败。

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

变更历史

变更时间变更内容概要操作
2023-11-24OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
出参OpenAPI 返回结构发生变更
2023-05-09OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
  • 本页导读 (1)
文档反馈