1. 接口描述
接口请求域名： cfw.tencentcloudapi.com 。
查询云防火墙概览页资源与配额详情信息，返回带宽配额、实例与规则配额、日志存储信息及相关能力标识。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeOverviewResourceQuota。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-04。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Scene | 否 | String | 返回视图范围 默认值：不传该参数时，默认返回完整的资源与配额详情数据 示例值：detail |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | OverviewResourceQuotaDataLite | 资源与配额详情数据 包含详情字段和能力标识，具体字段含义见关联数据结构说明。访问控制规则同时提供汇总字段及按互联网边界、NAT边界、VPC边界拆分的字段。 |
| ReturnCode | Integer | 返回代码 示例值：0 |
| ReturnMsg | String | 返回状态字符 示例值：success |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 资源与配额详情
概览页资源与配额详情抽屉
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOverviewResourceQuota
<公共请求参数>
{}输出示例
{
"Response": {
"Data": {
"Detail": {
"EastWestDetail": {
"AllocatedBandwidthUsedMbps": 2048,
"CanUsedBandwidthMbps": 2500,
"ClusterModeWidthMbps": 452,
"ClusterVpcMaxFlowBps": 25484,
"DiffRegionFwInsId": "",
"DiffRegionFwInsName": "",
"DiffRegionMaxFlowBps": 0,
"FwGroupId": "cfwg-8f6785ee",
"FwGroupMaxFlowBps": 1697845555,
"FwGroupName": "自动化",
"FwInsId": "cfwew-46cfffdc",
"FwInsMaxFlowBps": 1697845555,
"FwInsName": "自动化-上海",
"MasterSlaveModeWidthMbps": 2048,
"SameRegionFwInsId": "",
"SameRegionFwInsName": "",
"SameRegionMaxFlowBps": 0,
"TotalMbps": 2500,
"UsagePercent": 0.647676679611206,
"UsedBps": 1697845555
},
"LogStorageDetail": {
"AclSize": 7088386412,
"ArrearsStopWriting": 0,
"IdsSize": 825949749,
"NDRNetFlowSize": 37625103293,
"NDRRiskSize": 1876072,
"NDRStorageDay": 730,
"NetFlowSize": 30811297507,
"OperateSize": 55808837,
"PayMode": 1,
"StorageDay": 730,
"TotalBytes": 5368709120000,
"UsedBytes": 76408421870
},
"NDRDetail": {
"FlowPercent": 0.019475028850138187,
"InMaxBps": 41339813,
"MaxFlowBps": 41822306,
"OutMaxBps": 1598034,
"Status": 1,
"TotalMbps": 2048
},
"NorthSouthDetail": {
"BypassOnlyBandwidthMbps": 0,
"CanUsedBandwidthMbps": 300,
"InternetBandwidthTotalMbps": 300,
"MaxSerialRegion": "eu-frankfurt",
"NatBandwidthTotalMbps": 40,
"NetMaxFlowBps": 676507327,
"SerialBandwidthTotalMbps": 90,
"SerialRegionInFlowMax": 109794282,
"SerialRegionOutFlowMax": 11110480,
"UnusedBandwidthMbps": 0
},
"QuotaDetail": {
"AccessControlRuleTotal": 15000,
"AccessControlRuleUsed": 9,
"AddressTemplateTotal": 530,
"AddressTemplateUsed": 493,
"BlockIpCount": 13,
"BlockIpTotal": 20100,
"BlockIpUsed": 13,
"BlockListQuota": {
"InUsedCnt": 10,
"OutUsedCnt": 3,
"TotalCnt": 20100,
"UsedCnt": 13
},
"BlockListQuotaDetail": {
"BaseRemainCnt": 19987,
"BaseTotalCnt": 20000,
"BaseUsedCnt": 13,
"ExtensionRemainCnt": 100,
"ExtensionTotalCnt": 100,
"ExtensionUsedCnt": 0,
"RemainCnt": 20087,
"TotalCnt": 20100,
"UsedCnt": 13
},
"BorderRuleQuota": {
"AllowedNum": 5000,
"InEnableNum": 0,
"InTotal": 0,
"OutEnableNum": 6,
"OutTotal": 7,
"RemainExtensionNum": 100,
"RemainQuota": 5093,
"UsedNum": 7
},
"CommonInstanceRemain": 12,
"CommonInstanceTotal": 20,
"CommonInstanceUsed": 8,
"HoneyPotTotal": 10,
"HoneyPotUsed": 4,
"NatInstanceUsed": 4,
"NatRuleQuota": {
"AllowedNum": 5000,
"InEnableNum": 1,
"InTotal": 1,
"OutEnableNum": 0,
"OutTotal": 0,
"RemainExtensionNum": 100,
"RemainQuota": 5099,
"UsedNum": 1
},
"PublicIpTotal": 1124,
"PublicIpUsed": 37,
"SerialRegionUsed": 5,
"SgRuleQuotaTotal": 2000,
"SgRuleQuotaUsed": 16,
"TotalExtensionNum": 100,
"TotalExtensionUsed": 0,
"VpcInstanceUsed": 4,
"VpcRuleQuota": {
"AllowedNum": 5000,
"EdgeEnableRuleNum": 0,
"EdgeRuleNum": 0,
"GlobalEnableRuleNum": 1,
"GlobalRuleNum": 1,
"IsSwitchEnable": 1,
"RemainExtensionNum": 100,
"RemainQuota": 5099,
"UsedNum": 1,
"V4EnableRuleTotal": 1,
"V4RuleTotal": 1,
"V6EnableRuleTotal": 0,
"V6RuleTotal": 0
}
}
}
},
"ReturnCode": 0,
"ReturnMsg": "success",
"RequestId": "8e5ce370-585b-4fab-8635-5977d44ad905"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
