DescribeNatFirewallPrecheckDetail - Cloud Firewall - Alibaba Cloud Documentation Center

Queries the precheck details for a NAT firewall.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the request and response messages.	zh
RegionNo	string	No	The region ID.	cn-hangzhou
NatGatewayId	string	No	The ID of the NAT Gateway.	ngw-bp1okz6k7dge****

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-shenzhen
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: running: The precheck is in progress. passed: The precheck is passed. failed: The precheck failed.	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 each precheck item. Valid values: running: The precheck is in progress. passed: The precheck is passed. failed: The precheck failed.	passed
Info	string	The information about the failed precheck item.	VPC防火墙配额已满
Suggestion	string	The suggested solution.	VPC防火墙配额已满，建议您提高防火墙配额
PrecheckEntityGroupStatus	string	The status of the precheck. Valid values: running passed failed	running
FailedCount	integer	The number of failed precheck items.	9
RequestId	string	The ID of the request.	99A65AA0-C5B5-5092-BFCF-8111B436****

Examples

Success response

JSON format

{
  "IsFound": false,
  "PrecheckDetail": {
    "NetworkInstanceId": "vpc-m5emh0w6v2e15****",
    "RegionNo": "cn-shenzhen",
    "FirewallId": "vfw-tr-7a9c8901ed394****",
    "PrecheckTimestamp": "1715136000",
    "PrecheckStatus": "failed",
    "PrecheckEntityGroups": [
      {
        "Name": "test",
        "PrecheckEntities": [
          {
            "Name": "Precheck test",
            "Status": "passed",
            "Info": "VPC防火墙配额已满",
            "Suggestion": "VPC防火墙配额已满，建议您提高防火墙配额"
          }
        ],
        "PrecheckEntityGroupStatus": "running",
        "FailedCount": 9
      }
    ]
  },
  "RequestId": "99A65AA0-C5B5-5092-BFCF-8111B436****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorAliUid	Aliuid invalid.	The aliuid is invalid.
400	ErrorParameters	Error Parameters	The parameter is invalid.
400	ErrorDBSelectError	A database select error occurred.	The error message returned because an internal error has occurred in querying the database.
400	ErrorUnMarshalJSON	internal error.	Internal Error
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.