Querying Network ACL Groups
Function
This API is used to query all network ACL groups accessible to the tenant submitting the request. A maximum of 2,000 records can be returned for each query operation. If the number of records exceeds 2,000, the pagination marker will be returned.
URI
GET /v2.0/fwaas/firewall_groups
Example of querying groups by page
GET https://{Endpoint}/v2.0/fwaas/firewall_groups?limit=2&marker=cd600d47-0045-483f-87a1-5041ae2f513b&page_reverse=False
Table 1 describes the parameters.
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
Specifies that the ID of the network ACL group is used as the filtering condition. |
name |
No |
String |
Specifies that the name of the network ACL group is used as the filtering condition. |
description |
No |
String |
Specifies that the description of the network ACL group is used as the filtering condition. |
admin_state_up |
No |
Boolean |
Specifies that the admin state of the network ACL group is used as the filtering condition. The value can be true or false. |
tenant_id |
No |
String |
Specifies that the project ID of the network ACL group is used as the filtering condition. |
marker |
No |
String |
Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. This parameter can work together with the parameter limit.
|
limit |
No |
Integer |
Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. limit can be used together with marker. For details, see the parameter description of marker. |
Request Parameters
None
Example Request
GET https://{Endpoint}/v2.0/fwaas/firewall_groups
Response Parameters
Parameter |
Type |
Description |
---|---|---|
firewall_groups |
Array of Firewall Group objects |
Specifies the firewall group list. For details, see Table 3. |
firewall_groups_links |
Array of firewall_groups_link objects |
Specifies the firewall_groups_link object list. For details, see Table 4. Only when limit is used for filtering and the number of resources exceeds the value of limit or 2000 (default value of limit), value next will be returned for rel and a link for href. |
Attribute |
Type |
Description |
---|---|---|
id |
String |
Specifies the UUID of the network ACL group. |
name |
String |
Specifies the name of the network ACL group. |
description |
String |
Provides supplementary information about the network ACL group. |
tenant_id |
String |
Specifies the project ID. |
ingress_firewall_policy_id |
String |
Specifies the network ACL policy for inbound traffic. |
egress_firewall_policy_id |
String |
Specifies the network ACL policy for outbound traffic. |
ports |
Array of strings |
Specifies the list of ports bound with the network ACL group. |
public |
Boolean |
Specifies whether the firewall group can be shared by different tenants. |
status |
String |
Specifies the status of a network ACL group. The value can be:
|
admin_state_up |
Boolean |
Specifies the administrative status of the network ACL. |
project_id |
String |
Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. |
created_at |
String |
Specifies the time (UTC) when the resource is created. Format: yyyy-MM-ddTHH:mm:ss |
updated_at |
String |
Specifies the time (UTC) when the resource is updated. Format: yyyy-MM-ddTHH:mm:ss |
Example Response
{ "firewall_groups": [ { "status": "INACTIVE", "public": false, "egress_firewall_policy_id": null, "name": "", "admin_state_up": true, "ports": [ ], "tenant_id": "23c8a121505047b6869edf39f3062712", "id": "cd600d47-0045-483f-87a1-5041ae2f513b", "ingress_firewall_policy_id": null, "description": "", "project_id": "23c8a121505047b6869edf39f3062712", "created_at": "2018-09-12T08:24:14", "updated_at": "2018-09-12T08:24:14" }, { "status": "INACTIVE", "public": false, "egress_firewall_policy_id": "d939df29-fe76-4089-90c3-3778e4d53141", "name": "fwg-1475475043", "admin_state_up": true, "ports": [ ], "tenant_id": "0af57070695044ea9a70f04779e6aa1f", "id": "ca971b45-70ce-4879-9734-b6cac1d00845", "ingress_firewall_policy_id": "d939df29-fe76-4089-90c3-3778e4d53141", "description": "", "project_id": "0af57070695044ea9a70f04779e6aa1f", "created_at": "2018-09-12T08:24:14", "updated_at": "2018-09-12T08:24:14" } ], "firewall_groups_links": [ { "rel": "previous", "href": "https://{Endpoint}/v2.0/fwaas/firewall_groups?marker=cd600d47-0045-483f-87a1-5041ae2f513b&page_reverse=True" } ] }
Status Code
See Status Codes.
Error Code
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