DescribeNetworkAcls
Description
call the DescribeNetworkAcls interface to view the list of network ACLs.
Request Method
POST
Request Path
/apsara/route/Vpc/DescribeNetworkAcls
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| NetworkAclId | BODY | string | No | nacl-bp1lhl0taikrbgnh**** | ID of network ACL. |
| VpcId | BODY | string | No | vpc-1234**** | ID of VPC associated with network ACL. |
| PageSize | BODY | integer | No | 10 | The number of rows per page during paging query, the maximum value is 50, the default value is 10. |
| ResourceId | BODY | string | No | vsw-bp1de348lntdwnhbg**** | ID of the associated instance. ResourceType and ResourceId needs to be specified at the same time to take effect. |
| PageNumber | BODY | integer | No | 1 | page number of the list, the default value is 1. |
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| NetworkAclName | BODY | string | No | acl-1 | the name of the network ACL. is 2 to 128 characters in length and must start with a letter or Chinese, and can contain numbers, underscores (_) and dashes (-), but you cannot use http:// or https:// start. |
| ResourceType | BODY | string | No | VSwitch | The type of associated instance, only the value is VSwitch. ResourceType and ResourceId needs to be specified at the same time to take effect. |
| RegionId | BODY | string | Yes | cn-qingdao-env17-d01 | the region ID to which the network ACL belongs. you can obtain the region by calling DescribeRegions interface ID. |
| ClientToken | BODY | string | No | 0c593ea1-3bea-11e9-b96b-88e9fe63**** | Ensure request idempotence. Generate a parameter value from your client to ensure that the parameter value is unique between different requests. ClientToken only ASCII characters are supported and cannot exceed 64 characters. |
| version | BODY | string | No | 2016-01-01 | version of api |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| Policy | string | accept | authorization policy, value: accept: allowed. drop: reject. |
| IngressAclEntries | array of ingressaclentry | No sample value for this parameter. | incoming direction rule information. |
| Description | string | This is IngressAclEntries. | description information of the entry direction rule. |
| PageSize | string | 10 | the number of entries currently contained in the page. |
| Port | string | -1/-1 | source port range. |
| NetworkAcl | No sample value for this parameter. | No description for this parameter. | |
| OwnerId | long | 12345678 | the account ID of the network ACL. |
| EgressAclEntries | array of egressaclentry | No sample value for this parameter. | exit direction rule information. |
| IngressAclEntry | No sample value for this parameter. | No description for this parameter. | |
| PageNumber | string | 1 | current page number. |
| SourceCidrIp | string | 10.0.0.0/24 | source address segment. |
| Protocol | string | all | transport layer protocol, value: icmp: network control message protocol. gre: universal routing encapsulation protocol. tcp: transmission control protocol. udp: user datagram protocol. all: All protocols are supported. |
| Status | string | Available | status of network ACL. Available: available. Modifying: under configuration. |
| NetworkAcls | array of networkacl | No sample value for this parameter. | details of network ACL. |
| DestinationCidrIp | string | 10.0.0.0/24 | destination address segment. |
| NetworkAclId | string | nacl-a2do9e413e0spxscd**** | ID of network ACL. |
| RequestId | string | F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1 | request ID. |
| Resource | No sample value for this parameter. | No description for this parameter. | |
| ResourceType | string | VSwitch | the type of associated resource. |
| EgressAclEntry | No sample value for this parameter. | No description for this parameter. | |
| NetworkAclEntryName | string | acl-3 | The name of the entry direction rule. |
| TotalCount | string | 2 | Number of entries in the list. |
| EntryType | string | custom | rule type, value: custom: custom. system: system. |
| VpcId | string | vpc-a2d33rfpl72k5defr**** | ID of the associated VPC. |
| ResourceId | string | vsw-bp1de348lntdwcdf**** | ID of the associated resource. |
| CreationTime | string | 2019-04-25 11:44:17 | the creation time of the network ACL. |
| NetworkAclName | string | acl-8 | the name of the network ACL. |
| RegionId | string | cn-qingdao-env17-d01 | the region ID to which the network ACL belongs. |
| Resources | array of resource | No sample value for this parameter. | associated resource. |
| NetworkAclEntryId | string | nae-a2dk86arlydmezasw**** | ID of the entry direction rule entry. |
Example
Successful Response example
{
"Policy":"accept",
"IngressAclEntries":"",
"Description":"This is IngressAclEntries.",
"PageSize":"10",
"Port":"-1/-1",
"NetworkAcl":"",
"OwnerId":"12345678",
"EgressAclEntries":"",
"IngressAclEntry":"",
"PageNumber":"1",
"SourceCidrIp":"10.0.0.0/24",
"Protocol":"all",
"Status":"Available",
"NetworkAcls":"",
"DestinationCidrIp":"10.0.0.0/24",
"NetworkAclId":"nacl-a2do9e413e0spxscd****",
"RequestId":"F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1",
"Resource":"",
"ResourceType":"VSwitch",
"EgressAclEntry":"",
"NetworkAclEntryName":"acl-3",
"TotalCount":"2",
"EntryType":"custom",
"VpcId":"vpc-a2d33rfpl72k5defr****",
"ResourceId":"vsw-bp1de348lntdwcdf****",
"CreationTime":"2019-04-25 11:44:17",
"NetworkAclName":"acl-8",
"RegionId":"cn-qingdao-env17-d01",
"Resources":"",
"NetworkAclEntryId":"nae-a2dk86arlydmezasw****"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}