Help Center> Virtual Private Cloud> API Reference> Native OpenStack Neutron APIs (V2.0)> Network ACL> Creating a Network ACL Group
View PDF

Creating a Network ACL Group

Function

This API is used to create a network ACL group.

URI

POST /v2.0/fwaas/firewall_groups

Request Message

Table 1 Request parameter

Parameter

Type

Mandatory

Description

firewall_group

Object

Yes

Specifies the firewall group list. For details, see Table 2.
Table 2 Firewall Group objects

Attribute

Mandatory

Type

Description

name

No

String

Specifies the name of the network ACL group.

The value can contain a maximum of 255 characters.

description

No

String

Provides supplementary information about the network ACL group.

The value can contain a maximum of 255 characters.

ingress_firewall_policy_id

No

String

Specifies the network ACL policy for inbound traffic.

egress_firewall_policy_id

No

String

Specifies the network ACL policy for outbound traffic.

ports

No

Array of strings

Specifies the list of ports bound with the network ACL group.

The value must be the port ID of the distributed router.

admin_state_up

No

Boolean

Specifies whether the network ACL is controlled by the administrator.

The value can be true or false.

Response Message

Table 3 Response parameter

Parameter

Type

Description

firewall_group

Object

Specifies the firewall group list. For details, see Table 4.
Table 4 Firewall Group objects

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 policy can be shared by different tenants.

status

String

Specifies the status of the network ACL policy.

admin_state_up

Boolean

Specifies whether the network ACL is controlled by the administrator.

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:

Example request

POST https://{Endpoint}/v2.0/fwaas/firewall_groups

{
    "firewall_group": {
        "ingress_firewall_policy_id": "afc52ce9-5305-4ec9-9feb-44feb8330341", 
        "ports": [
            "c133f2bf-6937-4416-bb17-012e1be5cd2d"
        ]
    }
}

Example response

{
    "firewall_group": {
        "status": "PENDING_CREATE", 
        "public": false, 
        "egress_firewall_policy_id": null, 
        "name": "", 
        "admin_state_up": true, 
        "ports": [
            "c133f2bf-6937-4416-bb17-012e1be5cd2d"
        ], 
        "tenant_id": "23c8a121505047b6869edf39f3062712", 
        "id": "0415f554-26ed-44e7-a881-bdf4e6216e38", 
        "ingress_firewall_policy_id": "afc52ce9-5305-4ec9-9feb-44feb8330341", 
        "description": "",
        "project_id": "23c8a121505047b6869edf39f3062712",
        "created_at": "2018-09-12T08:24:14",
        "updated_at": "2018-09-12T08:24:14"
    }
}

Status Code

See Status Codes.

Error Code

See Error Codes.

Parent topic: Network ACL