查询防火墙详细信息
功能介绍
查询防火墙实例
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/firewall/exist
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 租户项目id |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 是 | Integer | 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 |
| limit | 是 | Integer | 每页显示个数,范围为1-1024 |
| service_type | 是 | Integer | 服务类型 0 南北向防火墙 1 东西向防火墙 |
| enterprise_project_id | 否 | String | 企业项目id,用户支持企业项目后,由企业项目生成的id。 |
| fw_instance_id | 否 | String | 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。 |
| name | 否 | String | 防火墙名称 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | GetFirewallInstanceData object | 查询防火墙实例数据 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| limit | Integer | 每页显示个数,范围为1-1024 |
| offset | Integer | 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 |
| total | Integer | 总数 |
| records | Array of GetFirewallInstanceResponseRecord objects | 查询防火墙实例信息列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| fw_instance_id | String | 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口。 |
| name | String | 防火墙名称 |
| ha_type | Integer | 集群类型 |
| charge_mode | Integer | 计费模式 0:包年/包月 1:按需 |
| service_type | Integer | 服务类型 |
| engine_type | Integer | 引擎类型 |
| flavor | Flavor object | 防火墙规格信息 |
| protect_objects | Array of ProtectObjectVO objects | 防护对象列表 |
| status | Integer | 防火墙状态列表,包括-1:等待支付,0:创建中,1,删除中,2:运行中,3:升级中,4:删除完成:5:冻结中,6:创建失败,7:删除失败,8:冻结失败,9:存储中,10:存储失败,11:升级失败 |
| is_old_firewall_instance | Boolean | 是否为旧引擎,true表示是,false表示不是 |
| is_available_obs | Boolean | 是否支持obs |
| is_support_threat_tags | Boolean | 是否支持威胁标签 |
| support_ipv6 | Boolean | 是否支持ipv6,true表示是,false表示不是 |
| feature_toggle | Map<String,Boolean> | 特性开关,boolean值为true表示是,false表示否 |
| resources | Array of FirewallInstanceResource objects | 防火墙资源列表 |
| fw_instance_name | String | 防火墙名称 |
| enterprise_project_id | String | 企业项目id,用户支持企业项目后,由企业项目生成的id。 |
| resource_id | String | 资源id |
| support_url_filtering | Boolean | 是否支持url过滤,true表示是,false表示不是 |
| tags | String | 标签列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| version | Integer | 防火墙版本,0:标准版,1:专业版,2:铂金版,3:基础版,购买时,当防火墙“charge_mode”为“postPaid”时,仅支持专业版。“charge_mode”为“prePaid”时,支持标准版、专业版。 |
| eip_count | Integer | eip数量 |
| vpc_count | Integer | vpc数量 |
| bandwidth | Integer | 带宽 |
| log_storage | Integer | 日志存储 |
| default_bandwidth | Integer | 默认防火墙带宽 |
| default_eip_count | Integer | 默认eip数 |
| default_log_storage | Integer | 默认日志存储 |
| default_vpc_count | Integer | 默认vpc数 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| object_id | String | 防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。 |
| object_name | String | 防护对象名称 |
| type | Integer | 防护对象类型:0 南北向,1 东西向护对象类型 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resource_id | String | 资源id |
| cloud_service_type | String | 服务类型,用于CBC使用,特指:hws.service.type.cfw |
| resource_type | String | 资源类型,包括: 1、云防火墙:hws.resource.type.cfw 2、EIP:hws.resource.type.cfw.exp.eip 3、带宽:hws.resource.type.cfw.exp.bandwidth 4、VPC:hws.resource.type.cfw.exp.vpc 5、日志存储:hws.resource.type.cfw.exp.logaudit |
| resource_spec_code | String | 库存单位码 |
| resource_size | Integer | 资源数量 |
| resource_size_measure_id | Integer | 资源单位 |
请求示例
查询项目id为9d80d070b6d44942af73c9c3d38e0429的项目存在的防火墙列表
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/firewall/exist?service_type=0&offset=0&limit=10 响应示例
状态码: 200
获取存在防火墙实例响应
{
"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
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 获取存在防火墙实例响应 |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
错误码
请参见错误码。