Querying Network ACLs
Function
This API is used to query network ACLs.
This API is now available in CN North-Beijing4, CN East-Shanghai1, CN South-Guangzhou, CN South-Shenzhen, CN Southwest-Guiyang1, and AP-Singapore.
URI
GET /v3/{project_id}/vpc/firewalls
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
admin_state_up |
No |
Boolean |
Whether a network ACL is enabled. |
enterprise_project_id |
No |
Array |
Enterprise project ID. This parameter can be used to filter the network ACLs of an enterprise project. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project. To obtain network ACLs of all enterprise projects, set this parameter to all_granted_eps. |
id |
No |
Array |
Unique ID of a network ACL, which can be used to filter the network ACL. Multiple IDs can be specified for filtering. |
limit |
No |
Integer |
Number of records returned on each page. Value range: 0 to 2000 |
marker |
No |
String |
Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. |
name |
No |
Array |
Name of a network ACL, which can be used to filter the network ACL. Multiple IDs can be specified for filtering. |
status |
No |
String |
Network ACL status. Enumerated values:
|
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
firewalls |
Array of ListFirewallDetail objects |
Network ACLs |
page_info |
PageInfo object |
Pagination information |
request_id |
String |
Request ID |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Network ACL ID, which uniquely identifies a network ACL. The value is a string in UUID format. |
name |
String |
Network ACL name. The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
description |
String |
Provides supplementary information about an IP address group. The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
project_id |
String |
ID of the project that a network ACL belongs to. |
created_at |
String |
Time when a network ACL is created UTC time in the format of yyyy-MM-ddTHH:mmssZ. The value is automatically generated by the system. |
updated_at |
String |
Time when a network ACL was last updated UTC time in the format of yyyy-MM-ddTHH:mmssZ. The value is automatically generated by the system. |
admin_state_up |
Boolean |
Whether a network ACL is enabled. The value can be true or false. true indicates that the network ACL is enabled, and false indicates that the network ACL is disabled. |
status |
String |
Network ACL status. |
enterprise_project_id |
String |
ID of the enterprise project that a network ACL belongs to. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project. |
tags |
Array of ResourceTag objects |
Network ACL tags. |
associations |
Array of FirewallAssociation objects |
Subnets that are associated with a network ACL |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key. Tag keys must be unique for each resource. Minimum length: 1 Maximum length: 128 |
value |
String |
Tag value. Maximum length: 255 |
Example Request
Query network ACLs.
GET https://{Endpoint}/v3/{project_id}/vpc/firewalls
Example Response
Status code: 200
OK
{ "firewalls" : [ { "id" : "e9a7731d-5bd9-4250-a524-b9a076fd5629", "name" : "network_acl_test1", "description" : "network_acl_test1", "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12", "created_at" : "2022-04-07T07:30:46Z", "updated_at" : "2022-04-07T07:30:46Z", "admin_state_up" : true, "enterprise_project_id" : "158ad39a-dab7-45a3-9b5a-2836b3cf93f9", "status" : "ACTIVE", "tags" : [ ], "associations" : [ { "virsubnet_id" : "8359e5b0-353f-4ef3-a071-98e67a34a143" } ] } ] }
Status Codes
See Status Codes.
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot