接口功能介绍
查询实例状态概览接口
接口约束
传参规范
URI
GET /vfw/v2_firewall_overview
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
urlType | 是 | String | 请求地址类型 | CTAPI | |
regionId | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 | ||
message | String | 返回信息 | 成功 | |
error | String | 错误码:CFW_0000 :成功!;CFW_0001:参数错误!;CFW_0002:业务错误! | CFW_0000 | |
returnObj | Object | 接口返回结果 | FirewallStatisticsVo |
表 FirewallStatisticsVo
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
firewallEdtion | String | 防火墙版本Advanced 高级版 | ||
protectionIpNum | Integer | 防护公网ip配额 | ||
flowProcessingCapacity | Integer | 互联网边界带宽规格 | ||
vpcQuota | Integer | 配额数量 | ||
vpcFlowProcessingCapacity | Integer | VPC边界带宽规格 | ||
expireTime | Long | 到期时间 |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
请求体body
{}
响应示例
{
"statusCode": "200",
"error": "CFW_0000",
"message": "成功!",
"returnObj":{
"protectionIpNum": 28,
"flowProcessingCapacity": 2485,
"vpcQuota": 10,
"vpcFlowProcessingCapacity": 2600,
"firewallEdition": "Enterprise",
"expireTime": 1731550194000
}
}
状态码
请参考 状态码
错误码
请参考 错误码