通過 API 查詢 VPC 防火牆預檢查狀態 - Cloud Firewall - 阿里雲 - Cloud Firewall

取得 VPC 防火牆預先檢查詳細資訊。

介面說明

QPS 限制

本介面的單一使用者 QPS 限制為每秒 10 次。超過限制時，API 呼叫將會被限流，這可能會影響您的業務，請合理呼叫。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-cloudfirewall:DescribeVpcFirewallPrecheckDetail

get

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
Lang	string	否	語言類型。取值： zh（預設）：中文。 en：英文。	zh
NetworkInstanceType	string	否	網路執行個體的類型。取值： cen_firewall：CEN 基礎版防火牆 cen_tr_firewall：CEN-TR 防火牆	cen_firewall
VpcId	string	否	VPC 執行個體 ID。VpcId 與 TransitRouterId 至少須提供其一：查詢基礎版防火牆時傳入 VpcId，查詢轉發路由器（TR）情境時傳入 TransitRouterId；兩者均缺省時返回 ErrorParameters。	vpc-2zev8s8rxao33xt****
Region	string	否	地域 ID。本介面實際上為必填，缺失時返回 ErrorParameters。	cn-hangzhou
CenId	string	否	雲企業網執行個體 ID。	cen-hxsqf2bv6di1a****
TransitRouterId	string	否	轉發路由器執行個體 ID。VpcId 與 TransitRouterId 至少須提供其一：查詢基礎版防火牆時傳入 VpcId，查詢轉發路由器（TR）情境時傳入 TransitRouterId；兩者均缺省時返回 ErrorParameters。	tr-2vcn4u2g86tm72****
MemberUid	string	否	雲端防火牆成員帳號的 UID。	134388541648****

返回參數

名稱	類型	描述	樣本值
	object
IsFound	boolean	是否存在任務。	false
PrecheckDetail	object	預先檢查的詳細資訊。
NetworkInstanceId	string	網路執行個體 ID。	vpc-m5emh0w6v2e15****
RegionNo	string	所在地域 ID。	cn-shanghai
FirewallId	string	防火牆執行個體 ID。	vfw-tr-7a9c8901ed394****
PrecheckTimestamp	string	預先檢查時間戳記。	1715136000
PrecheckStatus	string	預先檢查狀態。取值： running：預先檢查正在進行中 passed：預先檢查已通過 failed：預先檢查未通過	failed
PrecheckEntityGroups	array<object>	預先檢查環節的分組清單。
	array<object>	預先檢查環節的分組清單。
Name	string	預先檢查執行個體名稱。	test
PrecheckEntities	array<object>	各預先檢查項目的執行情況。
	object	各預先檢查項目的執行情況。
Name	string	預先檢查項目名稱。	Precheck test
Status	string	各預先檢查項目的狀態。取值： running：預先檢查正在進行中 passed：預先檢查已通過 failed：預先檢查未通過	passed
Info	string	檢查未通過的資訊。	VPC Firewall Quota Full
Suggestion	string	處理建議。	The VPC firewall quota is full. We recommend that you increase the firewall quota
PrecheckEntityGroupStatus	string	預先檢查的狀態。取值： running passed failed	running
FailedCount	integer	預先檢查未通過的規則數量。	3
RequestId	string	返回結果的請求 ID。	4FB718F0-CC04-5A12-B17B-188CFC3F****

樣本

正常返回樣本

JSON格式

{
  "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****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	ErrorAliUid	Aliuid invalid.
400	ErrorInvalidMemberUid	Member uid is invalid
400	ErrorRegionNoError	Region is error, please reselect
400	ErrorParameters	A parameter error occurred.
400	ErrorDBSelectError	A database select error occurred.
400	ErrorPreCheckDoing	Pre-check in progress, please try again later.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。