調用 DescribeApisecExamples 擷取 WAF API 安全資料 - Web Application Firewall - 阿里雲 - Web Application Firewall

查詢 API 安全範例資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-waf:DescribeApisecExamples

list

*All Resource

*

acs:ResourceGroupId

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	WAF 執行個體 ID。說明您可以透過呼叫 DescribeInstance 介面查看目前 WAF 執行個體 ID。	waf_elasticity-cn-0xldbqtm005
RegionId	string	否	WAF 執行個體所屬地域。取值： cn-hangzhou：表示中國內地。 ap-southeast-1：表示非中國內地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里雲資源群組 ID。	rg-acfm***q
ApiId	string	是	API 的 ID。	867ade***24ee6e205b8da82b8f84
ExampleType	string	否	範例的類型。枚舉值： risk : 表示風險類型。 sensitive : 表示敏感資訊類型。	sensitive
RequestSensitiveTypeList	array	否	請求敏感資訊類型清單。
	string	否	請求敏感資訊類型。	1001
ResponseSensitiveTypeList	array	否	回應敏感資訊類型清單。
	string	否	回應敏感資訊類型。	1001
AbnormalTag	string	否	風險類型。	LackOfSpeedLimit
NextToken	string	否	下一頁查詢憑證（Token）。	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	否	分頁查詢時每頁個數。取值範圍為：1-5，預設值為 5。	5
ClusterId	string	否	混合雲叢集 ID。說明僅針對混合雲情境，您可以呼叫 DescribeHybridCloudClusters 取得混合雲叢集資訊。	176

返回參數

名稱	類型	描述	樣本值
	object	請求結果。
RequestId	string	本次請求的 ID。	D7861F61-5B61-46CE-A47C-6B19160D5EB0
Examples	array<object>	範例清單。
	array<object>	範例資訊。
Protocol	string	通訊協定的類型。取值： http：表示 http 通訊協定。 https：表示 https 通訊協定。	http
ApiUrl	string	完整請求路徑。	http://www.test.com/api/v1/hello.php?token=TkJGQw
PocPayload	string	驗證請求。	curl -X GET -H 'Accept: /' -H 'Connection: keep-alive' -H 'User-agent: Mozilla/5.0 (Windows NT 10.0; WOW64)' -H 'Host: www.test.com' -H 'Accept-encoding: gzip, deflate' -H 'Eagleeye-rpcid: 0.1' 'http://www.test.com/api/v1/hello.php?token=TkJGQw'
RequestSensitiveData	array<object>	請求敏感資料資訊清單。
	object	請求敏感資料資訊。
SensitiveCode	string	敏感資訊類型。	1000
SensitiveDataList	array	敏感資訊資料列表。
	string	敏感資訊資料。	90.88.49.19
ResponseSensitiveData	array<object>	回應敏感資料資訊清單。
	object	回應敏感資料資訊。
SensitiveCode	string	敏感資訊類型。	1000
SensitiveDataList	array	敏感資訊資料列表。
	string	敏感資訊資料。	90.88.49.19
Request	string	範例請求內容，以一系列參數建構的 JSON 格式轉化成字串。包含的欄位如下： method：表示請求方法。 host：表示請求網域。 header：表示請求標頭。 server_port：表示服務連接埠。 body：表示請求主體內容。 url：表示請求路徑。 server_protocol：表示伺服器端通訊協定。說明當 body 內容超過 16K，僅返回部分內容。	{ "method": "GET", "host": "www.test.com", "header": { "Accept": "/", "Connection": "keep-alive" }, "server_port": "80", "body": "-", "url": "/api/v1/hello.php?token=TkJGQw", "server_protocol": "HTTP/1.1" }
Response	string	範例回應內容，以一系列參數建構的 JSON 格式轉化成字串。包含的欄位如下： status：表示狀態碼。 header：表示回應標頭。 body：表示回應主體內容。說明當 body 內容超過 16K，僅返回部分內容。	{ "header": { "Connection": "keep-alive", "Content-Encoding": "gzip", "Content-Type": "text/html; charset=UTF-8" }, "body": "xxxx", "status": 200 }
NextToken	string	下一頁查詢憑證（Token）。	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	分頁查詢時每頁個數。取值範圍為：1-5，預設值為 5。	5
TotalCount	integer	結果的總數。	5

樣本

正常返回樣本

JSON格式

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Examples": [
    {
      "Protocol": "http",
      "ApiUrl": "http://www.test.com/api/v1/hello.php?token=TkJGQw",
      "PocPayload": "curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: Mozilla/5.0 (Windows NT 10.0; WOW64)' -H 'Host: www.test.com' -H 'Accept-encoding: gzip, deflate' -H 'Eagleeye-rpcid: 0.1' 'http://www.test.com/api/v1/hello.php?token=TkJGQw'",
      "RequestSensitiveData": [
        {
          "SensitiveCode": "1000",
          "SensitiveDataList": [
            "90.88.49.19"
          ]
        }
      ],
      "ResponseSensitiveData": [
        {
          "SensitiveCode": "1000",
          "SensitiveDataList": [
            "90.88.49.19"
          ]
        }
      ],
      "Request": "{\n  \"method\": \"GET\",\n  \"host\": \"www.test.com\",\n  \"header\": {\n    \"Accept\": \"*/*\",\n    \"Connection\": \"keep-alive\"\n  },\n  \"server_port\": \"80\",\n  \"body\": \"-\",\n  \"url\": \"/api/v1/hello.php?token=TkJGQw\",\n  \"server_protocol\": \"HTTP/1.1\"\n}",
      "Response": "{\n  \"header\": {\n    \"Connection\": \"keep-alive\",\n    \"Content-Encoding\": \"gzip\",\n    \"Content-Type\": \"text/html; charset=UTF-8\"\n  },\n  \"body\": \"xxxx\",\n  \"status\": 200\n}"
    }
  ],
  "NextToken": "AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS",
  "MaxResults": 5,
  "TotalCount": 5
}

錯誤碼

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

變更歷史

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