Queries statistics about assets protected by Cloud Firewall.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| SourceIp |
string |
No |
The source IP address of the visitor. |
112.239.XX.XX |
| Lang |
string |
No |
The language of the request and response. Valid values: -zh: Chinese -en: English |
zh |
| Lang |
string |
No |
The language of the request and response. Valid values: -zh: Chinese -en: English |
zh |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response object. |
||
| RequestId |
string |
The ID of the request. |
850A84******25g4d2 |
| ResourceSpecStatistic |
object |
Statistics on instance type usage. |
|
| IpNumUsed |
integer |
The number of public IP addresses that are protected. |
10 |
| IpNumSpec |
integer |
The quota for protected public IP addresses. |
20 |
| SensitiveDataIpNumSpec |
integer |
The quota for protected IP addresses for sensitive data. |
0 |
| SensitiveDataIpNumUsed |
integer |
The number of protected IP addresses for sensitive data. |
0 |
| GeneralInstanceSpecStatistic |
object |
The specifications of the general-purpose instance. |
|
| TotalGeneralInstanceUsedCnt |
integer |
The total number of used general-purpose instances. |
1 |
| TotalCfwGeneralInstanceUsedCnt |
integer |
The number of enabled instances for the Internet firewall. |
1 |
| TotalVfwGeneralInstanceUsedCnt |
integer |
The number of enabled instances for the VPC firewall. |
1 |
| TotalNatGeneralInstanceUsedCnt |
integer |
The number of enabled instances for the NAT firewall. |
1 |
| TotalCfwGeneralInstanceCnt |
integer |
The total number of instances for the Internet firewall. |
1 |
| TotalNatGeneralInstanceCnt |
integer |
The total number of instances for the NAT firewall. |
1 |
| CfwGeneralInstanceRegionStatistic |
array<object> |
Statistics on instance types for the Internet firewall by region. |
|
|
object |
The details of the statistics. |
||
| RegionNo |
string |
The region ID. |
cn-hangzhou |
| MemberList |
array |
The list of members in the region. |
|
|
string |
A member in the region. |
123 |
|
| CfwTotalGeneralInstanceRegionStatistic |
array<object> |
The overall statistics on instance types for the Internet firewall by region. |
|
|
object |
The details of the statistics. |
||
| RegionNo |
string |
The region ID. |
cn-shanghai |
| MemberList |
array |
The list of members in the region. |
|
|
string |
A member in the region. |
123 |
Examples
Success response
JSON format
{
"RequestId": "850A84******25g4d2",
"ResourceSpecStatistic": {
"IpNumUsed": 10,
"IpNumSpec": 20,
"SensitiveDataIpNumSpec": 0,
"SensitiveDataIpNumUsed": 0
},
"GeneralInstanceSpecStatistic": {
"TotalGeneralInstanceUsedCnt": 1,
"TotalCfwGeneralInstanceUsedCnt": 1,
"TotalVfwGeneralInstanceUsedCnt": 1,
"TotalNatGeneralInstanceUsedCnt": 1,
"TotalCfwGeneralInstanceCnt": 1,
"TotalNatGeneralInstanceCnt": 1,
"CfwGeneralInstanceRegionStatistic": [
{
"RegionNo": "cn-hangzhou",
"MemberList": [
"123"
]
}
],
"CfwTotalGeneralInstanceRegionStatistic": [
{
"RegionNo": "cn-shanghai",
"MemberList": [
"123"
]
}
]
}
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | ErrorParamsNotEnough | Parameters are insufficient. | Parameters are insufficient. |
| 400 | ErrorDbFailed | Query db failed. | DB access error. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.