Querying Firewall Details¶
Function¶
This API is used to query firewall instance details.
URI¶
GET /v1/{project_id}/firewall/exist
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID. |
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. The value ranges from 1 to 1024. |
service_type | Yes | Integer | Service type. Currently, only 0 (Internet protection) is supported. |
enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0. |
fw_instance_id | No | String | Firewall instance ID, which is automatically generated by the system after a CFW is created. You can call the API for querying firewall instances. By default, if this parameter is left blank, information about the first firewall under the account is returned. If this parameter is specified, information about the corresponding firewall is returned. |
name | No | String | Firewall name. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
X-Auth-Token | Yes | String | User token. You can obtain the token by referring to Obtaining a User Token. |
Content-Type | Yes | String | Content type. It can only be set to application/json. |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
|---|---|---|
data | GetFirewallInstanceData object | Query firewall instance data. |
Parameter | Type | Description |
|---|---|---|
limit | Integer | Number of records displayed on each page. The value ranges from 1 to 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. |
total | Integer | Total number of firewalls. |
records | Array of GetFirewallInstanceResponseRecord objects | Query the firewall instance list. |
Parameter | Type | Description |
|---|---|---|
fw_instance_id | String | Firewall instance ID, which is automatically generated by the system after a CFW instance is created. You can call the API for querying firewall instances. By default, if fw_instance_Id is left blank, information about the first firewall under the account is returned. If fw_instance_Id is specified, the information about the firewall corresponding to fw_instance_Id is returned. |
name | String | Firewall name. |
ha_type | Integer | Cluster type: 0 (active/standby), 1 (cluster). In active/standby mode, there are four nodes. Two active nodes form a cluster, and the other two are the standby of the active nodes. In cluster mode, only two nodes are started to form a cluster. |
charge_mode | Integer | Billing mode: 0 (yearly/monthly), 1 (pay-per-use). |
service_type | Integer | Firewall protection type. Currently, its value can only be 0 (Internet protection). |
engine_type | Integer | Engine type. Its value can only be 1 (Hillstone engine). |
flavor | Flavor object | Firewall specifications. |
protect_objects | Array of ProtectObjectVO objects | Protected object list. |
status | Integer | Firewall status: -1 (waiting for payment), 0 (creating), 1 (deleting), 2 (running), 3 (upgrading), 4 (deleted), 5 (frozen), 6 (creation failed), 7 (deletion failed), 8 (freezing failed), or 9 (being stored), 10 (storage failed), or 11 (upgrade failed). |
is_old_firewall_instance | Boolean | Whether an engine old: true (yes), false (no). |
is_available_obs | Boolean | Whether OBS is supported: true (yes), false (no). |
is_support_threat_tags | Boolean | Whether threat intelligence tags are supported: true (yes), false (no). |
support_ipv6 | Boolean | Whether IPv6 is supported: true (yes), false (no). |
feature_toggle | Map<String,Boolean> | Whether a feature is enabled: true (yes), false (no). |
resources | Array of FirewallInstanceResource objects | Firewall resource list. |
fw_instance_name | String | Firewall name. |
enterprise_project_id | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0. |
resource_id | String | Firewall resource ID, which is the same as fw_instance_id. |
support_url_filtering | Boolean | Whether website filtering is supported: true (yes), false (no). |
tags | String | Tag list, which is a JSON string converted from the tag key value map, for example, "{"key":"value"}". |
Parameter | Type | Description |
|---|---|---|
version | Integer | Firewall version. Its value can only be 1 (professional edition). |
eip_count | Integer | Number of EIPs. |
vpc_count | Integer | Number of VPCs. |
bandwidth | Integer | Bandwidth, in Mbit/s. |
log_storage | Integer | Log storage, in bytes. |
default_bandwidth | Integer | Default firewall bandwidth, in Mbit/s. The value is 10 for the standard edition, 50 for the professional edition, and 200 for the pay-per-use professional edition. |
default_eip_count | Integer | Default number of EIPs. The value is 20 for the standard edition, 50 for the professional edition, and 1,000 for the pay-per-use professional edition. |
default_log_storage | Integer | Default log storage, in bytes. The default value is 0. |
default_vpc_count | Integer | Default number of VPCs. The value is 0 for the standard edition, 2 for the professional edition, and 5 for the pay-per-use professional edition. |
Parameter | Type | Description |
|---|---|---|
object_id | String | Protected object ID. It is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. |
object_name | String | Protected object name. |
type | Integer | Project type: 0 (north-south), 1 (east-west). |
Parameter | Type | Description |
|---|---|---|
resource_id | String | Resource ID. It can be the firewall ID, bandwidth ID, EIP ID, VPC ID, or the ID returned after CBC callback. |
cloud_service_type | String | Service type, which is used by CBC. The value is otc.service.type.cfw. |
resource_type | String | Resource type.Enumeration values:- otc.resource.type.cfw (cloud firewall)- otc.resource.type.cfw.exp.eip (EIP)- otc.resource.type.cfw.exp.bandwidth (bandwidth)- otc.resource.type.cfw.exp (VPC) |
resource_spec_code | String | Inventory unit code: cfw.standard (firewall standard edition), cfw.professional (firewall professional edition), cfw.expack.eip.standard (EIP standard edition), cfw.expack.eip.professional (EIP professional edition), cfw.expack.bandwidth.standard (bandwidth basic edition), cfw.expack.bandwidth.professional (bandwidth professional edition), or cfw.expack.vpc.professional (VPC professional edition). |
resource_size | Integer | Resource quantity. |
resource_size_measure_id | Integer | Resource unit. |
Example Requests¶
Query the firewall list of project 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 an existing firewall instance.
{
"data": {
"limit": 10,
"offset": 0,
"records": [
{
"charge_mode": 0,
"engine_type": 1,
"enterprise_project_id": "default",
"feature_toggle": {
"is_support_anti_virus": true,
"is_support_application": true,
"is_support_tcp_proxy": false,
"is_support_url_profile": true,
"is_support_threat_tags": true,
"is_support_flow_associated_host": false,
"is_support_predefined": true,
"isSupportSession": false,
"is_support_acl_region_config": true,
"is_support_ips": true,
"is_support_ew_create_er_tenant_inspection_mode": false,
"ips_rule_list": true,
"long_connect": true,
"is_support_ew_create_vpc_peering_inspection_mode": true,
"alarm_config": true,
"is_not_support_resource_reduction": false,
"acl_multi_object": true,
"is_support_advanced_ips_rule": true,
"is_support_multi_account": false,
"is_support_capture": true,
"is_support_ew_create_er_bearer_inspection_mode": true
},
"flavor": {
"bandwidth": 60,
"eip_count": 51,
"log_storage": 0,
"version": 1,
"vpc_count": 8,
"default_eip_count": 20,
"default_vpc_count": 0,
"default_bandwidth": 10,
"default_log_storage": 0
},
"tags": "{\"key1234\":\"1234\",\"key122\":\"2222\"}",
"fw_instance_id": "546af3f8-88e9-47f2-a205-2346d7090925",
"fw_instance_name": "test",
"ha_type": 1,
"is_available_obs": false,
"is_old_firewall_instance": false,
"is_support_threat_tags": false,
"name": "1680054140516",
"protect_objects": [
{
"object_id": "ae42418e-f077-41a0-9d3b-5b2f5ad9102b",
"object_name": "1680054141674",
"type": 0
},
{
"object_id": "be83d202-df0b-498d-a96e-41589dc85c86",
"object_name": "ew-1680070626042",
"type": 1
}
],
"resource_id": "546af3f8-88e9-47f2-a205-2346d7090925",
"resources": [
{
"cloud_service_type": "hws.service.type.cfw",
"resource_id": "546af3f8-88e9-47f2-a205-2346d7090925",
"resource_spec_code": "cfw.professional",
"resource_type": "hws.resource.type.cfw"
},
{
"cloud_service_type": "hws.service.type.cfw",
"resource_id": "0acdd5c7-1178-4bea-b5b6-bd55dc5e2669",
"resource_size": 5,
"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": "4002620c-916a-49c7-8042-cbe02fc17e61",
"resource_size": 5,
"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": "0235c7db-0baa-4c82-8db2-7b8d5108bd86",
"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": "079ade46-18cd-4917-b7bb-00d402931097",
"resource_size": 6,
"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": "dd078faa-abfd-4e63-b681-1a93489955b9",
"resource_size": 1,
"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": "4d78d523-745d-4d54-a9ca-e6d25e555bde",
"resource_size": 10,
"resource_size_measure_id": 36,
"resource_spec_code": "cfw.expack.bandwidth.professional",
"resource_type": "hws.resource.type.cfw.exp.bandwidth"
}
],
"service_type": 0,
"status": 2,
"support_ipv6": true,
"support_url_filtering": true
}
],
"total": 1
}
}
Status Codes¶
Status Code | Description |
|---|---|
200 | Response to the request for obtaining an existing firewall instance. |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Error Codes¶
See Error Codes.