調用DescribeApisecSuggestions查詢API資產防護建議-Web Application Firewall-阿里雲 - Web Application Firewall

查詢 API 資產的防護建議。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-waf:DescribeApisecSuggestions

get

*All Resource

*

acs:ResourceGroupId

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	WAF 執行個體 ID。說明您可以透過呼叫 DescribeInstance 介面查看目前 WAF 執行個體 ID。	waf_v2_public_cn-pe336n43m04
ApiId	string	是	API 的 ID。	a60fd7e3021fe371c06dc1dcb883def0
ClusterId	string	否	混合雲叢集 ID。說明僅針對混合雲情境，您可以呼叫 DescribeHybridCloudClusters 取得混合雲叢集資訊。	428
RegionId	string	否	WAF 執行個體所屬地域。取值： cn-hangzhou：表示中國內地。 ap-southeast-1：表示非中國內地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里雲資源群組 ID。	rg-acfm***q

返回參數

名稱	類型	描述	樣本值
	object	請求結果。
RequestId	string	請求 ID。	D7861F61-5B61-46CE-A47C-6B19160D5EB0
Data	array<object>	防護建議清單。
	object	防護建議資訊。
SuggestRule	string	防護建議規則內容，以一系列參數建構的 JSON 格式轉化成字串。包括： event_tags：表示事件類型。 black_iplist：表示 IP 黑名單清單。 ip_baseline：表示 IP 清單。 freq_baseline：表示限流頻率資訊。 client_id_baseline：表示用戶端資訊。 country_baseline：表示國家資訊。 province_baseline：表示地區資訊。 sensitive_type：表示敏感資訊類型。	{ "rule": "ClientRule", "client_id_baseline": ["Edge"] }
MatchedHost	string	API 介面所屬的網域或 IP。	a.aliyun.com
ApiFormat	string	API 介面。	/apisec/v1/saveinfo
SuggestType	string	防護建議類型。取值： BotRule：表示 Bot 規則。 BlackIPRule：表示 IP 黑名單規則。 WhiteIPRule：表示 IP 白名單規則。 RateLimitRule：表示限流規則。 ClientRule：表示用戶端規則。 GeoRule：表示地域規則。 SensitiveRule：表示敏感資訊規則。 UnauthRule：表示鑑權規則。	WhiteIPRule
SuggestId	string	防護建議 ID。	15060a1f8fed40130b7c4a7bf8d8733b

樣本

正常返回樣本

JSON格式

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Data": [
    {
      "SuggestRule": "{\n    \"rule\": \"ClientRule\",\n    \"client_id_baseline\": [\"Edge\"]\n}",
      "MatchedHost": "a.aliyun.com",
      "ApiFormat": "/apisec/v1/saveinfo",
      "SuggestType": "WhiteIPRule",
      "SuggestId": "15060a1f8fed40130b7c4a7bf8d8733b"
    }
  ]
}

錯誤碼

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

變更歷史

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