文档首页/ 云防火墙 CFW/ API参考/ API/ 防火墙管理/ 查询防火墙配额信息
更新时间:2025-08-28 GMT+08:00
分享

查询防火墙配额信息

功能介绍

查询防火墙配额信息

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/cfw/{fw_instance_id}/quota

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

fw_instance_id

String

参数解释

防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

config_type

String

参数解释

防火墙配额类型

约束限制

不涉及

取值范围

ACL:ACL规则配额

DNS_DOMAIN_SET:网络域名组配额

DOMAIN:域名组域名成员配额

DOMAIN_DEVICE:域名设备配额

DNS_DOMAIN_SET_PARSE_IP:网络域名组解析IP配额

APPLICATION_DOMAIN_SET:应用域名组配额

APPLICATION_DOMAIN_SET_ITEM:应用域名组域名成员配额

APPLICATION_DOMAIN_SET_ITEM_DEVICE:应用域名组设备配额

ADDR_SET:地址组配额

ADDR_SET_ITEM:地址组IP地址成员配额

ADDR_SET_ITEM_DEVICE:地址组IP地址设备配额

SERV_SET:服务组配额

SERV_SET_ITEM:服务组服务成员配额

SERV_SET_ITEM_DEVICE:服务组服务设备配额

BLACKLIST:黑名单配额

WHITELIST:白名单配额

PRIVATE_NETWORK_SEGMENT:私网网段配额

默认取值

不涉及

set_id

String

参数解释

组Id,查询IP地址组地址成员配额,域名组域名成员配额,服务组服务成员配额时必传,地址组id,可通过查询地址组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得,域名组id,可通过查询域名组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得,服务组id,可通过获取服务组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

ShowConfigQuotaDto object

表4 ShowConfigQuotaDto

参数

参数类型

描述

item_info

ItemInfo object

参数解释

防火墙配额信息

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

max_quota

Integer

参数解释

防火墙成员最大配额

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

quota_type

String

参数解释

防火墙成员配额类型

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

used_quota

Integer

参数解释

已使用配额

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表5 ItemInfo

参数

参数类型

描述

max_quota

Integer

参数解释

最大配额

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

used_quota

Integer

参数解释

已使用配额

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

extras_info

Map<String,String>

参数解释

额外参数,ACL和网络域名使用

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及

error_msg

String

参数解释

错误描述

取值范围

不涉及

请求示例

查询项目ID为eb7accd78ea845078275b2ad5280a109防火墙ID为8a996d43-75bd-48b4-b1b8-de0706b72b8f的防火墙配额信息,类型为ACL

https://{Endpoint}/v2/5de88e3e18124fa99675fb51ceceaa31/quota?config_type=ACL

响应示例

状态码:200

OK

{
  "data" : {
    "max_quota" : 3801,
    "used_quota" : 4,
    "quota_type" : "ADDR_SET",
    "item_info" : {
      "max_quota" : 30001,
      "used_quota" : 97
    }
  }
}

状态码:400

Bad Request

{
  "error_code" : "CFW.00200003",
  "error_msg" : "参数错误"
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

相关文档