Updated on 2024-04-15 GMT+08:00

Updating a Network ACL Group

Function

This API is used to update a network ACL group.

URI

PUT /v2.0/fwaas/firewall_groups/{firewall_group_id}

Request Parameters

Table 1 Request parameter

Parameter

Type

Mandatory

Description

firewall_group

firewall_group object

Yes

Specifies the firewall group. 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.

NOTE:

The port is the one whose device_owner is network:router_interface_distributed.

  • Call the VPC API for querying the port ID. The filtering criteria are the specified network_id and device_owner. The network_id is the network ID of the subnet associated with the network ACL.
    Example:
    GET https://{Endpoint}/v1/{project_id}/ports?network_id={network_id}&device_owner=network%3Arouter_interface_distributed

admin_state_up

No

Boolean

Specifies the administrative status of the network ACL.

The value can be true or false.

Example Request

Associate the ACL group whose ID is 2fb0e81f-9f63-44b2-9894-c13a3284594a with the outbound ACL policy 53f36c32-db25-4856-a0ba-e605fd88c5e9.

PUT https://{Endpoint}/v2.0/fwaas/firewall_groups/2fb0e81f-9f63-44b2-9894-c13a3284594a 

{
    "firewall_group": {
        "egress_firewall_policy_id": "53f36c32-db25-4856-a0ba-e605fd88c5e9"
    }
}

Response Parameters

Table 3 Response parameter

Parameter

Type

Description

firewall_group

firewall_group object

Specifies the firewall group. 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 group can be shared by different tenants.

status

String

Specifies the status of the network ACL policy.

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_group": {
        "status": "PENDING_UPDATE", 
        "public": false, 
        "egress_firewall_policy_id": "53f36c32-db25-4856-a0ba-e605fd88c5e9", 
        "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.