Querying a Firewall Instance

Function

This API is used to query a firewall instance.

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

URI

GET /v1/{project_id}/firewall/exist

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
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.
limit	Yes	Integer	Number of records displayed on each page
service_type	Yes	Integer	Service type 0. North-south firewall 1. East-west firewall Minimum: 0 Maximum: 1 Enumeration values: 0 1
enterprise_project_id	No	String	Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.
fw_instance_id	No	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.

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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
data	Table 5 object	get firewall instance response data

**Table 5** GetFirewallInstanceData
Parameter	Type	Description
limit	Integer	Number of records displayed on each page
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.
total	Integer	total
records	Array of Table 6 objects	Get firewall instance records

**Table 6** GetFirewallInstanceResponseRecord
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.
name	String	Firewall name
ha_type	Integer	Cluster type
charge_mode	Integer	Billing mode. The value can be 0 (yearly/ monthly) or 1 (pay-per-use).
service_type	Integer	Service type
engine_type	Integer	Engine type
flavor	Table 7 object	Firewall specifications
protect_objects	Array of Table 8 objects	Project list
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 Enumeration values: -1 0 1 2 3 4 5 6 7 8 9 10 11
is_old_firewall_instance	Boolean	Whether the engine is an old engine. The options are true (yes) and false (no). Enumeration values: true false
support_ipv6	Boolean	Whether IPv6 is supported. The options are true (yes) and false (no).
feature_toggle	Map<String,B oolean>	Whether to enable the feature. The options are true (yes) and false (no).
resources	Array of Table 9 objects	Firewall instance resources
fw_instance_name	String	firewall name
enterprise_project_id	String	Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

**Table 7** Flavor
Parameter	Type	Description
version	Integer	Firewall version. The value can be 0 (standard edition), 1 (professional edition), 2 (platinum edition), or 3 (basic edition). Enumeration values: 0 1 2 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

**Table 8** ProtectObjectVO
Parameter	Type	Description
object_id	String	Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.
object_name	String	Protected object name
type	Integer	Project type. The options are as follows: 0: north-south; 1: east-west. Enumeration values: 0 1

**Table 9** FirewallInstanceResource
Parameter	Type	Description
resource_id	String	Resource ID
cloud_service_type	String	Service type, which is used by CBC. The value is hws.service.type.cfw.
resource_type	String	Resource type. The options are as follows:1. CFW: hws.resource.type.cfw 2. EIP:hws.resource.type.cfw.exp.eip 3. Bandwidth: hws.resource.type.cfw.exp.bandwidth 4. VPC: hws.resource.type.cfw.exp.vpc 5. Log storage: hws.resource.type.cfw.exp.logaudit
resource_spec_code	String	Inventory unit code
resource_size	Integer	Resource quantity
resource_size_measure_id	Integer	Resource unit name

Example Requests

Query the firewall list of the project whose ID is 9d80d070b6d44942af73c9c3d38e0429.

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/firewall/exist? service_type=0&offset=0&limit=10

Example Responses

Status code: 200

Response to the request for obtaining a firewall instance

{
  "data" : {
    "limit" : 10,
    "offset" : 0,
    "records" : [ {
      "charge_mode" : 0,
      "engine_type" : 1,
      "feature_toggle" : {
        "long_connect" : true,
        "alarm_config" : true
      },
      "flavor" : {
        "bandwidth" : 60,
        "eip_count" : 52,
        "log_storage" : 0,
        "version" : 1,
        "vpc_count" : 4
      },
      "fw_instance_id" : "2af58b7c-893c-4453-a984-bdd9b1bd6318",
      "fw_instance_name" : "fw_instance_name",
      "enterprise_project_id" : "enterprise_project_id",
      "ha_type" : 1,
      "is_old_firewall_instance" : false,
      "name" : "1663891762130",
      "protect_objects" : [ {
        "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2",
        "object_name" : "1663891762130",
        "type" : 0
      }, {
        "object_id" : "32ecaf73-bbd8-47e5-af51-b9c88affda21",
        "object_name" : "ew-1663892880929",
        "type" : 1
      } ],
      "resources" : [ {
        "cloud_service_type" : "hws.service.type.cfw",
        "resource_id" : "6f8a4871-7258-4560-b396-aba4bb5840a6",
        "resource_size" : 2,
        "resource_size_measure_id" : 14,
        "resource_spec_code" : "cfw.expack.eip.professional",
        "resource_type" : "hws.resource.type.cfw.exp.eip"
      }, {
        "cloud_service_type" : "hws.service.type.cfw",
        "resource_id" : "d7da8a0c-d4f4-43e6-affd-60e20daf4caa",
        "resource_size" : 10,
        "resource_size_measure_id" : 36,
        "resource_spec_code" : "cfw.expack.bandwidth.professional",
        "resource_type" : "hws.resource.type.cfw.exp.bandwidth"
      }, {
        "cloud_service_type" : "hws.service.type.cfw",
        "resource_id" : "550f52af-f6e2-4a9e-bdb3-85bb0b2dd4fa",
        "resource_size" : 2,
        "resource_size_measure_id" : 14,
        "resource_spec_code" : "cfw.expack.vpc.professional",
        "resource_type" : "hws.resource.type.cfw.exp.vpc"
      }, {
        "cloud_service_type" : "hws.service.type.cfw",
        "resource_id" : "53048c0d-45db-4773-b2f3-fca8d43351fe",
        "resource_spec_code" : "cfw.professional",
        "resource_type" : "hws.resource.type.cfw"
      } ],
      "service_type" : 0,
      "status" : 2,
      "support_ipv6" : true
    } ],
    "total" : 1
  }
}

Status Codes

Status Code	Description
200	Response to the request for obtaining a firewall instance
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic:Cloud Firewall Information Management

Previous topic: Cloud Firewall Information Management

Next topic: Service Group Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.