doc-exports/docs/cfw/api-ref/ListFirewallList.html

list firewall list

Function

list firewall list

URI

POST /v1/{project_id}/firewalls/list

Table 1 Path Parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	project ID

Table 2 Query Parameters

Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

Request Parameters

Table 3 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Table 4 Request body parameters

Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.
key_word	No	String	key
tags	No	Array of TagInfo objects	tags
limit	Yes	Integer	Number of records displayed on each page, in the range 1-1024
offset	Yes	Integer	Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

Table 5 TagInfo

Parameter	Mandatory	Type	Description
key	No	String	key
values	No	Array of strings	tag values

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter	Type	Description
user_support_eps	Boolean	Whether to enable eps. The options are true (yes) and false (no).
has_ndr	Boolean	Whether NDR exists
is_support_postpaid	Boolean	Whether postpaid is supported
is_support_basic_version	Boolean	Whether basic version is supported
is_support_buy_professional	Boolean	Whether professional version firewall is supported to buy
data	HttpFirewallInstanceListResponseData object	query firewall instance list response

Table 7 HttpFirewallInstanceListResponseData

Parameter	Type	Description
limit	Integer	Number of records displayed on each page, in the range 1-1024
offset	Integer	Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.
project_id	String	project ID
total	Integer	total
records	Array of FirewallInstanceVO objects	query firewall isntance list

Table 8 FirewallInstanceVO

Parameter	Type	Description
fw_instance_id	String	Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.
resource_id	String	resource id
name	String	name
fw_instance_name	String	firewall instance name
enterprise_project_id	String	Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.
ha_type	Integer	ha type
charge_mode	Integer	Billing mode 0: Yearly/monthly subscription 1: On-demand
service_type	Integer	service type
engine_type	Integer
flavor	Flavor object	flavor
status	Integer	Firewall status list. The options are as follows: -1: waiting for payment; 0: creating; 1: deleting; 2: running; 3: upgrading; 4: deletion completed; 5: freezing; 6: creation failed; 7: deletion failed; 8: freezing failed; 9: storage in progress; 10: storage failed; 11: upgrade failed

Table 9 Flavor

Parameter	Type	Description
version	Integer	Firewall version. The value can be 0 (standard edition), 1 (professional edition), or 3 (basic edition). Enumeration values: 0 1 3
eip_count	Integer	Number of EIPs Minimum: 1
vpc_count	Integer	Number of VPCs Minimum: 1
bandwidth	Integer	Bandwidth Minimum: 1
log_storage	Integer	Log storage
session_concurrent	Integer	concurrent session
session_create	Integer	created session
total_rule_count	Integer	total rule count
used_rule_count	Integer	used rule count
vpc_bandwith	Integer	vpc bandwith

Example Requests

Query the firewall list on the first page of the enterprise project whose ID is all_granted_eps and project ID is 14181c1245cf4fd786824efe1e2b9388.

https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/firewalls/list?enterprise_project_id=all_granted_eps

{
  "limit" : 10,
  "offset" : 0
}

Example Responses

Status code: 200

list firewall list response

{
  "data" : {
    "limit" : 10,
    "offset" : 0,
    "project_id" : "14181c1245cf4fd786824efe1e2b9388",
    "records" : [ {
      "charge_mode" : 0,
      "engine_type" : 1,
      "enterprise_project_id" : "default",
      "flavor" : {
        "bandwidth" : 60,
        "eip_count" : 51,
        "log_storage" : 0,
        "version" : 1,
        "vpc_count" : 8
      },
      "fw_instance_id" : "546af3f8-88e9-47f2-a205-2346d7090925",
      "fw_instance_name" : "test",
      "ha_type" : 1,
      "name" : "1680054140516",
      "resource_id" : "546af3f8-88e9-47f2-a205-2346d7090925",
      "service_type" : 0,
      "status" : 2
    } ],
    "total" : 1
  },
  "user_support_eps" : false,
  "has_ndr" : false,
  "is_support_postpaid" : false,
  "is_support_basic_version" : false,
  "is_support_buy_professional" : false
}

Status Codes

Status Code	Description
200	list firewall list response

Error Codes

See Error Codes.

Parent topic: Firewall Management