Retrieves the details of a VPC firewall precheck.
Operation description
QPS limit
The queries per second (QPS) limit for a single user is 10 calls per second. If the limit is exceeded, API calls are throttled. This may impact your business. Plan your calls accordingly.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Lang |
string |
No |
The language of the response. Valid values:
|
zh |
| NetworkInstanceType |
string |
No |
The type of the network instance. Valid values:
|
cen_firewall |
| VpcId |
string |
No |
The ID of the VPC. |
vpc-2zev8s8rxao33xt**** |
| Region |
string |
No |
The region ID. |
cn-hangzhou |
| CenId |
string |
No |
The ID of the CEN instance. |
cen-hxsqf2bv6di1a**** |
| Lang |
string |
No |
The language of the response. Valid values:
|
zh |
| TransitRouterId |
string |
No |
The ID of the transit router instance. |
tr-2vcn4u2g86tm72**** |
| MemberUid |
string |
No |
The UID of the member account in Cloud Firewall. |
134388541648**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| IsFound |
boolean |
Indicates whether a task exists. |
false |
| PrecheckDetail |
object |
The details of the precheck. |
|
| NetworkInstanceId |
string |
The ID of the network instance. |
vpc-m5emh0w6v2e15**** |
| RegionNo |
string |
The region ID. |
cn-shanghai |
| FirewallId |
string |
The ID of the firewall instance. |
vfw-tr-7a9c8901ed394**** |
| PrecheckTimestamp |
string |
The timestamp of the precheck. |
1715136000 |
| PrecheckStatus |
string |
The status of the precheck. Valid values:
|
failed |
| PrecheckEntityGroups |
array<object> |
The list of precheck item groups. |
|
|
array<object> |
The list of precheck item groups. |
||
| Name |
string |
The name of the precheck instance. |
test |
| PrecheckEntities |
array<object> |
The execution status of each precheck item. |
|
|
object |
The execution status of each precheck item. |
||
| Name |
string |
The name of the precheck item. |
Precheck test |
| Status |
string |
The status of the precheck item. Valid values:
|
passed |
| Info |
string |
The information about the failed precheck. |
VPC防火墙配额已满 |
| Suggestion |
string |
The suggested solution. |
VPC防火墙配额已满，建议您提高防火墙配额 |
| PrecheckEntityGroupStatus |
string |
The status of the precheck group. Valid values:
|
running |
| FailedCount |
integer |
The number of rules that failed the precheck. |
3 |
| RequestId |
string |
The ID of the request. |
4FB718F0-CC04-5A12-B17B-188CFC3F**** |
Examples
Success response
JSON format
{
"IsFound": false,
"PrecheckDetail": {
"NetworkInstanceId": "vpc-m5emh0w6v2e15****",
"RegionNo": "cn-shanghai",
"FirewallId": "vfw-tr-7a9c8901ed394****",
"PrecheckTimestamp": "1715136000",
"PrecheckStatus": "failed",
"PrecheckEntityGroups": [
{
"Name": "test",
"PrecheckEntities": [
{
"Name": "Precheck test",
"Status": "passed",
"Info": "VPC防火墙配额已满",
"Suggestion": "VPC防火墙配额已满，建议您提高防火墙配额"
}
],
"PrecheckEntityGroupStatus": "running",
"FailedCount": 3
}
]
},
"RequestId": "4FB718F0-CC04-5A12-B17B-188CFC3F****"
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | ErrorAliUid | Aliuid invalid. | The aliuid is invalid. |
| 400 | ErrorInvalidMemberUid | Member uid is invalid | The member is invalid. |
| 400 | ErrorRegionNoError | Region is error, please reselect | The specified region is invalid. Enter another value. |
| 400 | ErrorParameters | A parameter error occurred. | A parameter error occurred. |
| 400 | ErrorDBSelectError | A database select error occurred. | The error message returned because an internal error has occurred in querying the database. |
| 400 | ErrorPreCheckDoing | Pre-check in progress, please try again later. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.