全部產品
Search

搜尋本產品

    Web Application Firewall：DescribeDefenseResources

    文件中心

    Web Application Firewall：DescribeDefenseResources

    更新時間：Jun 25, 2026

    分頁查詢防護對象。

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    yundun-waf:DescribeDefenseResources

    list

    *DefenseResource

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    InstanceId

    string

    否

    WAF 執行個體 ID。

    說明

    您可以透過呼叫 DescribeInstance 介面查看當前 WAF 執行個體 ID。

    waf_cdnsdf3****
    PageNumber

    integer

    否

    分頁查詢時，返回第幾頁資料。預設值為 1，表示返回第 1 頁資料。

    1
    PageSize

    integer

    否

    分頁查詢時，每頁包含多少條結果。預設值為 10，表示每頁包含 10 條結果。

    10
    Query

    string

    否

    查詢條件，JSON 格式的字串。

    說明

    根據不同的查詢條件，查詢到的防護對象結果不同。詳細資訊，請參見Query 參數描述。

    {\"product\":\"waf\"}
    Tag

    array<object>

    否

    資源標籤列表，最多包含 20 個子項。

    object

    否

    資源標籤，由標籤鍵和標籤值組成。

    Value

    string

    否

    標籤值。

    TagValue1
    Key

    string

    否

    標籤鍵。

    Tagkey1
    ResourceManagerResourceGroupId

    string

    否

    阿里雲資源群組 ID。

    rg-acfm***q
    RegionId

    string

    否

    WAF 執行個體所屬地域。取值：

    • cn-hangzhou：表示中國內地。

    • ap-southeast-1：表示非中國內地。

    cn-hangzhou

    Query 參數詳解

    參數描述
    名稱類型是否必選範例值描述
    productString可選waf資產類型，取值：
    - waf：表示透過 Cname 或其他方式接入 WAF。
    - alb：表示透過 ALB 接入。
    - clb：表示透過 CLB 接入。
    - ecs：表示透過 ECS 接入。
    - mse：表示透過 MSE 接入。
    - fc：表示透過 FC 接入。
    resourceLikeString可選example.aliyundoc.c要查詢的防護對象名稱。您可以設定該參數，模糊查詢已接入 WAF 的防護對象。
    resourceString可選example.aliyundoc.com-waf要查詢的防護對象名稱。您可以設定該參數，精確查詢已接入 WAF 的防護對象。
    resourceInString可選example1.aliyundoc.com,example2.aliyundoc.com要查詢的多個防護對象。您可以設定該參數，查詢多個已接入 WAF 的防護對象。多個防護對象之間使用英文逗號（,）分隔。
    instanceIdString可選alb-nifa24****要查詢的防護對象的執行個體 ID。您可以設定該參數，精確查詢已接入 WAF 的防護對象的執行個體 ID。
    domainString可選example.aliyundoc.com要查詢的防護對象的網域名稱。您可以設定該參數，精確查詢已接入 WAF 的防護對象的網域名稱。
    resourceGroupString可選group1要查詢的防護對象組。
    inGroupBoolean可選true防護對象是否已加入該防護對象組。
    ownerUserIdString可選135********23要查詢防護對象的資產歸屬帳號。您可以設定該參數，精確查詢多帳號場景中歸屬某一帳號的 WAF 防護對象。
    orderByString可選resource設定防護對象排序方式。取值：
    - resource : 表示按防護對象名稱排序。
    - gmtModified : 表示按修改時間排序。
    descBoolean可選true設定排序順序。取值：
    - false : 表示正序顯示。
    - true : 表示倒序顯示。
    範例
    {
    "product ": "waf",
    "resource": "example.aliyundoc.com-waf",
    "domain": "example.aliyundoc.com",
    "resourceLike ": "example.aliyundoc.c",
    "InstaneId": "waf_cn****",
    "resourceIn": "example1.aliyundoc.com,example2.aliyundoc.com",
    "ownerUserId": "135**********41"
}
```。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    請求返回結構體。

    TotalCount

    integer

    返回結果的總數。

    73
    RequestId

    string

    請求 ID。

    618F2626-DB27-5187-8C6C-4E61A491****
    Resources

    array<object>

    防護對象列表。

    array<object>

    防護對象資訊。

    Pattern

    string

    防護對象的防護形式。

    domain
    Description

    string

    描述資訊。

    test
    XffStatus

    integer

    防護對象是否開啟 xff 代理。

    1
    GmtModified

    integer

    防護對象修改時間，單位：毫秒。

    1665633032000
    Resource

    string

    防護對象名稱。

    alb-rencs***
    AcwV3SecureStatus

    integer

    滑塊 cookie 的 secure 屬性狀態。

    • 0：表示關閉。

    • 1：表示開啟。

    0
    Product

    string

    雲端產品名稱。

    alb
    AcwCookieStatus

    integer

    追蹤 cookie 開關狀態。

    • 0：表示關閉。

    • 1：表示開啟。

    1
    AcwSecureStatus

    integer

    追蹤 cookie 的 secure 屬性狀態。

    • 0：表示關閉。

    • 1：表示開啟。

    0
    ResourceManagerResourceGroupId

    string

    阿里雲資源群組 ID。

    rg-acfm***q
    GmtCreate

    integer

    防護對象建立時間，單位：毫秒。

    1652149203187
    OwnerUserId

    string

    多帳號統一管理場景中防護對象資產歸屬帳號。

    135*********46
    ResourceOrigin

    string

    防護對象來源。

    custom
    ResourceGroup

    string

    防護對象加入防護組的名稱。

    test
    Detail

    object

    防護對象的具體描述資訊，Map 中不同的鍵值對表示防護對象不同的屬性。

    {"domain":"eou.eleme.cn","uri":"/"}
    CustomHeaders

    array

    自訂 xff 頭用來取真實的用戶端來源 IP，當 xff=1 且該欄位為空時表示取 xff 頭中第一個 IP 作為用戶端來源 IP。

    string

    自訂頭欄位資訊。

    afbfbajf
    ResponseHeaders

    array<object>

    回應標頭參數。

    object

    回應標頭參數。

    Key

    string

    指定的自訂回應標頭的鍵。

    Header-Key
    Value

    string

    指定的自訂回應標頭的值。

    Header-Value
    InstanceId

    string

    WAF 執行個體 ID。

    waf_v2_public_cn-k*****
    ResourceStatus

    string

    防護對象狀態。取值為：

    • initializing：表示預設防護初始化中。

    • active：表示正常運行。

    • init_failed：表示預設防護初始化失敗。

    樣本

    正常返回樣本

    JSON格式

    {
  "TotalCount": 73,
  "RequestId": "618F2626-DB27-5187-8C6C-4E61A491****",
  "Resources": [
    {
      "Pattern": "domain",
      "Description": "test",
      "XffStatus": 1,
      "GmtModified": 1665633032000,
      "Resource": "alb-rencs***",
      "AcwV3SecureStatus": 0,
      "Product": "alb",
      "AcwCookieStatus": 1,
      "AcwSecureStatus": 0,
      "ResourceManagerResourceGroupId": "rg-acfm***q",
      "GmtCreate": 1652149203187,
      "OwnerUserId": "135*********46",
      "ResourceOrigin": "custom",
      "ResourceGroup": "test",
      "Detail": {
        "domain": "eou.eleme.cn",
        "uri": "/"
      },
      "CustomHeaders": [
        "afbfbajf"
      ],
      "ResponseHeaders": [
        {
          "Key": "Header-Key",
          "Value": "Header-Value"
        }
      ],
      "InstanceId": "waf_v2_public_cn-k*****",
      "ResourceStatus": ""
    }
  ]
}

    錯誤碼

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

    變更歷史

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