Query VPC Firewall Precheck Status via API - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Retrieves the precheck details of a VPC firewall.

Operation description

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation at an appropriate frequency.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cloudfirewall:DescribeVpcFirewallPrecheckDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language type. Valid values: zh (default): Chinese. en: English.	zh
NetworkInstanceType	string	No	The type of the network instance. Valid values: cen_firewall: CEN basic edition firewall cen_tr_firewall: CEN-TR firewall	cen_firewall
VpcId	string	No	The VPC-connected instance ID. You must specify at least one of VpcId and TransitRouterId. Specify VpcId when querying a basic edition firewall, or specify TransitRouterId when querying a forward routing (TR) scenario. If neither is specified, ErrorParameters is returned.	vpc-2zev8s8rxao33xt****
Region	string	No	The region ID. This parameter is required. If it is not specified, ErrorParameters is returned.	cn-hangzhou
CenId	string	No	The Cloud Enterprise Network (CEN) instance ID.	cen-hxsqf2bv6di1a****
TransitRouterId	string	No	The transit router instance ID. You must specify at least one of VpcId and TransitRouterId. Specify VpcId when querying a basic edition firewall, or specify TransitRouterId when querying a transit router (TR) scenario. If neither is specified, ErrorParameters is returned.	tr-2vcn4u2g86tm72****
MemberUid	string	No	The UID of the Cloud Firewall member accounts.	134388541648****

Response elements

Element	Type	Description	Example
	object
IsFound	boolean	Indicates whether the task exists.	false
PrecheckDetail	object	The precheck details.
NetworkInstanceId	string	The network instance ID.	vpc-m5emh0w6v2e15****
RegionNo	string	The region ID.	cn-shanghai
FirewallId	string	The firewall instance ID.	vfw-tr-7a9c8901ed394****
PrecheckTimestamp	string	The precheck timestamp.	1715136000
PrecheckStatus	string	The precheck status. Valid values: running: The precheck is in progress. passed: The precheck passed. failed: The precheck failed.	failed
PrecheckEntityGroups	array<object>	The list of precheck entity groups.
	array<object>	The list of precheck entity groups.
Name	string	The precheck instance name.	test
PrecheckEntities	array<object>	The execution details of each precheck item.
	object	The execution details of each precheck item.
Name	string	The precheck item name.	Precheck test
Status	string	The status of each precheck item. Valid values: running: The precheck is in progress. passed: The precheck passed. failed: The precheck failed.	passed
Info	string	The information about the precheck failure.	VPC Firewall Quota Full
Suggestion	string	The suggested action.	The VPC firewall quota is full. We recommend that you increase the firewall quota
PrecheckEntityGroupStatus	string	The precheck status. Valid values: running passed failed	running
FailedCount	integer	The number of precheck rules that failed.	3
RequestId	string	The request ID.	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 Firewall Quota Full",
            "Suggestion": "The VPC firewall quota is full. We recommend that you increase the firewall quota"
          }
        ],
        "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.
400	MissingParameter.VpcIdOrTransitRouterId	Either VpcId or TransitRouterId must be provided.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.