調用DescribeDefenseResource查詢單個防護對象詳情-Web Application Firewall-阿里雲 - Web Application Firewall

查詢單個防護物件。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-waf:DescribeDefenseResource

get

*DefenseResource

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/{#Resource}

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	否	WAF 實例 ID。說明您可以透過呼叫 DescribeInstance 介面檢視當前 WAF 實例 ID。	waf_v3prepaid_public_cn-4xl****i60i
ResourceManagerResourceGroupId	string	否	阿里雲資源組 ID。	rg-acfm***q
Resource	string	是	要查詢的防護物件名稱。您可以設定該參數，精確查詢已接入 WAF 的防護物件。	example.aliyundoc.com-waf
RegionId	string	否	WAF 實例所屬地域。取值： cn-hangzhou：表示中國內地。 ap-southeast-1：表示非中國內地。	cn-hangzhou

返回參數

名稱	類型	描述	樣本值
	object	請求返回結構體。
RequestId	string	請求 ID。	439AADF2-368C-5E98-B14E-3086****0573
Resource	object	防護物件資訊。
GmtCreate	integer	防護物件建立時間，單位：毫秒。	1607493144000
GmtModified	integer	防護物件修改時間，單位：毫秒。	1691720010000
Product	string	雲產品名稱。	alb
Resource	string	防護物件名稱。	alb-rencs***
ResourceGroup	string	防護物件加入的防護物件組的名稱。	example_resource_group
Detail	object	防護物件的具體描述資訊，Map 中不同的鍵值對表示防護物件不同的屬性。	{ "product": "waf", "domain": "demo.aliyundoc****.com" }
Pattern	string	防護物件的防護形式。	domain
XffStatus	integer	WAF 前是否開啟七層代理（高防/CDN 等）。取值： 0：未開啟。 1：開啟。	0
CustomHeaders	array	指定 Header 欄位列表。說明 XffStatus = 1 時，取指定 Header 欄位中的第一個 IP 作為客戶端源 IP，避免 XFF 偽造，輸入多個 Header 時按順序依次嘗試取源 IP，如果第一個取不到則取第二個，依次類推，如果所有指定 Header 都取不到，則取 X-Forwarded-For 中第一個 IP。XffStatus = 1 時，表示從第一個獲取。
	string	指定的 Header 欄位。	x-forwarded-for
ResourceOrigin	string	防護物件來源。取值： custom：表示從接入管理建立的防護物件。 access：表示使用者自定義建立的防護物件。	custom
Description	string	描述資訊。	This is Description
ResourceManagerResourceGroupId	string	阿里雲資源組 ID。	rg-acfmoiy****p2oq
AcwCookieStatus	integer	跟蹤 cookie 開關狀態。 0：表示關閉。 1：表示開啟。	0
AcwSecureStatus	integer	跟蹤 cookie 的 secure 屬性狀態。 0：表示關閉。 1：表示開啟。	0
AcwV3SecureStatus	integer	滑塊 cookie 的 secure 屬性狀態。 0：表示關閉。 1：表示開啟。	0
OwnerUserId	string	防護物件歸屬 UID。	170457******9107
ResponseHeaders	array<object>	響應頭參數。
	object	響應頭參數
Key	string	指定的自訂回應標頭的鍵。	Header-Key
Value	string	指定的自訂回應標頭的值。	Header-Value
InstanceId	string	WAF 實例 ID。	waf_v2_public_cn-wwo****
ResourceStatus	string	防護物件狀態。取值為： initializing：表示預設防護初始化中。 active：表示正常執行。 init_failed：表示預設防護初始化失敗。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "439AADF2-368C-5E98-B14E-3086****0573",
  "Resource": {
    "GmtCreate": 1607493144000,
    "GmtModified": 1691720010000,
    "Product": "alb",
    "Resource": "alb-rencs***\n",
    "ResourceGroup": "example_resource_group",
    "Detail": {
      "product": "waf",
      "domain": "demo.aliyundoc****.com"
    },
    "Pattern": "domain",
    "XffStatus": 0,
    "CustomHeaders": [
      "x-forwarded-for"
    ],
    "ResourceOrigin": "custom",
    "Description": "This is Description",
    "ResourceManagerResourceGroupId": "rg-acfmoiy****p2oq",
    "AcwCookieStatus": 0,
    "AcwSecureStatus": 0,
    "AcwV3SecureStatus": 0,
    "OwnerUserId": "170457******9107",
    "ResponseHeaders": [
      {
        "Key": "Header-Key\n",
        "Value": "Header-Value\n"
      }
    ],
    "InstanceId": "waf_v2_public_cn-wwo****",
    "ResourceStatus": ""
  }
}

錯誤碼

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

變更歷史

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