調用DescribeCommonLogFields介面查詢所有日誌欄位-Web Application Firewall-阿里雲

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-waf:DescribeCommonLogFields

list

*全部資源

*

acs:ResourceGroupId

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	WAF 執行個體的 ID。說明您可以調用 DescribeInstance 查詢當前 WAF 執行個體的 ID。	waf_v3prepaid_public_cn-l*****
IsRequired	boolean	否	日誌欄位是否為必選欄位。 true：表示必選日誌欄位。 false：表示非必選日誌欄位。	false
IsDefault	boolean	否	日誌欄位是否為預設欄位。 true：表示查詢預設日誌欄位。 false：表示查詢非預設日誌欄位。	true
LogKeyList	array	否	要查詢的日誌欄位列表。
	string	否	要查詢的日誌欄位。	final_action
RegionId	string	否	WAF 執行個體所屬地區。取值： cn-hangzhou：表示中國內地。 ap-southeast-1：表示非中國內地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里雲資源群組 ID。	rg-aek2sxgs*****

返回參數

名稱	類型	描述	樣本值
	object
TotalCount	integer	日誌欄位總數。	6
RequestId	string	當前請求的 ID。	AB0775EB-2594-598A-97E1-51B1*******
LogFieldList	array<object>	日誌欄位列表。
	object	日誌欄位詳情。
Status	boolean	日誌欄位狀態列表。取值： 0：表示下線狀態。 1：表示上線狀態或使用中。 2：表示即將下線。 3：表示即將上線。	1
IsDefault	boolean	日誌欄位是否為預設欄位。 true：表示預設日誌欄位。 false：表示非預設日誌欄位。	true
IsRequired	boolean	日誌欄位是否為必選欄位。 true：表示必選日誌欄位。 false：表示非必選日誌欄位。	true
LogKey	string	日誌欄位。說明具體的日誌欄位含義，可以查閱WAF 官方文檔（日誌欄位說明）。	final_action

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 6,
  "RequestId": "AB0775EB-2594-598A-97E1-51B1*******",
  "LogFieldList": [
    {
      "Status": true,
      "IsDefault": true,
      "IsRequired": true,
      "LogKey": "final_action"
    }
  ]
}

錯誤碼

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

變更歷史

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