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

文档中心

立即注册

导航

DescribeNetworkAclAttributes

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

调用 DescribeNetworkAclAttributes 接口，查看指定网络ACL的详情。

调试

API Explorer

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

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeNetworkAclAttributes	要执行的操作。取值：DescribeNetworkAclAttributes。
Version	String	是	2020-04-01	API版本信息，取值为：2020-04-01。
NetworkAclId	String	是	nacl-bp1fg655nh68xyz9****	待查看网络ACL的ID。您可以调用 DescribeNetworkAcls 接口，查询网络ACL的ID。

返回参数

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。
NetworkAclAttribute	Array of Struct	-	网络ACL的详细信息。具体请见下表“NetworkAclAttribute结构”。

NetworkAclAttribute结构

参数名称	类型	示例值	描述
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	Array of Struct	-	网络ACL的标签信息。具体请参见下表“Tag结构”。
IngressAclEntries	Array of Struct	-	网络ACL入方向规则的信息。详细信息请参见下表“IngressAclEntries结构”。若存在多条入方向规则，返回结果按照入方向规则的优先级降序进行排序。
EgressAclEntries	Array of Struct	-	网络ACL出方向规则的详细信息。详细信息请参见下表“EgressAclEntries结构”。若存在多条出方向规则，返回结果按照入方向规则的优先级降序进行排序。
Resources	Array of Struct	-	网络ACL关联资源的详细信息。具体请参见下表“Resources结构”。

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	入方向规则源地址的网段。
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	目标地址的网段。
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=DescribeNetworkAclAttributes&Version=2020-04-01&NetworkAclId=nacl-bp1fg655nh68xyz9**** HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeNetworkAclAttributes",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "NetworkAclAttribute": {
            "AccountId": "2000****",
            "NetworkAclId": "nacl-bp1fg655nh68xyz9****",
            "NetworkAclName": "test-acl",
            "Description": "TestDescription",
            "VpcId": "vpc-bp67acfmxazb4p****",
            "Status": "Available",
            "CreationTime": "22017-12-05T22:40:00+08:00",
            "UpdateTime": "2017-12-05T22:40:00+08:00",
            "ProjectName": "default",
            "Tags": [
                    {
                        "Key":"k1",
                        "Value":"v1"
                    }
             ],
            "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",
                    "SourceCidrIp": "10.XX.XX.0/24",
                    "Protocol": "all",
                    "Priority": 1,
                    "Port": "-1/-1"
                }
            ],
            "Resources": [
                {
                    "Status": "BINDED",
                    "ResourceId": "subnet-bp1de348lntdwcdf****"
                }
            ]
        }
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
404	InvalidNetworkAcl.NotFound	The specified Network ACL does not exist.	指定的网络ACL不存在。