Qin Ying, Fan 7e6f07b803 VPC API 20240320 version

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>

2024-09-05 12:25:23 +00:00

16 KiB

Raw Blame History

Querying a Firewall Group

Function

This API is used to query details about a specific firewall group.

URI

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

Table 1 describes the parameters.

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
firewall_group_id	Yes	String	Specifies the firewall group ID, which uniquely identifies the firewall group. The fire_group_id value is used as the filter.

Request Parameters

None

Example Request

GET https://{Endpoint}/v2.0/fwaas/firewall_groups/a504a4cf-9300-40e0-b2d4-649bd157c55a

Response Parameters

**Table 2** Response parameter
Parameter	Type	Description
firewall_group	firewall_group object	Specifies the firewall group. For details, see Table 3.

**Table 3** **Firewall Group** objects
Attribute	Type	Description
id	String	Specifies the UUID of the firewall group.
name	String	Specifies the name of the firewall group.
description	String	Provides supplementary information about the firewall group.
tenant_id	String	Specifies the project ID.
ingress_firewall_policy_id	String	Specifies the firewall policy for inbound traffic.
egress_firewall_policy_id	String	Specifies the firewall policy for outbound traffic.
ports	Array of strings	Specifies the list of ports bound with the firewall group.
public	Boolean	Specifies whether the firewall group can be shared by different tenants.
status	String	Specifies the status of the firewall policy. The value can be: ACTIVE (Normal) INACTIVE (Inactive) ERROR (Error occurred) PENDING_CREATE (Creating) PENDING_UPDATE (Updating) PENDING_DELETE (Deleting)
admin_state_up	Boolean	Specifies the administrative status of the firewall.
project_id	String	Specifies the 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": "ACTIVE", 
        "public": false, 
        "egress_firewall_policy_id": null, 
        "name": "bobby_fwg1", 
        "admin_state_up": true, 
        "ports": [
            "16e6d779-15e9-48fb-abc5-b86457792a15"
        ], 
        "tenant_id": "23c8a121505047b6869edf39f3062712", 
        "id": "a504a4cf-9300-40e0-b2d4-649bd157c55a", 
        "ingress_firewall_policy_id": "fed2d88f-d0e7-4cc5-bd7e-c495f67037b6", 
        "description": "test",
        "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: Firewall

16 KiB Raw Blame History