全部產品
Search
文件中心

Web Application Firewall:DescribeBotRuleLabels

更新時間:Aug 03, 2026

查詢 BOT 管理規則標籤資訊。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-waf:DescribeBotRuleLabels

list

*全部資源。

*

  • acs:ResourceGroupId

請求參數

名稱

類型

必填

描述

樣本值

InstanceId

string

WAF 執行個體 ID。

說明

您可以透過呼叫 DescribeInstance 介面檢視您目前的 WAF 執行個體 ID。

waf_v3prepaid_public_cn-53y4******

SubScene

string

Bot 管理防護場景類型。

枚舉值:

  • app :

    表示 App 防護場景。

  • web :

    表示 Web 防護場景。

app

ResourceManagerResourceGroupId

string

阿里雲資源群組 ID。

rg-acfm***q

RegionId

string

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

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

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

cn-hangzhou

LabelType

string

要查詢的 BOT 規則標籤類型。

human_machine_challenge

NextToken

string

下一頁查詢憑證(Token),如果有下一頁,則該欄位會有回傳值。

說明

只要該參數有回傳值,即表示還有下一頁。您可以將回傳的 NextToken 作為請求參數再次取得下一頁的資料,直到無回傳值為止,即表示已獲取所有資料。

AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS

MaxResults

integer

分頁查詢時每頁筆數。取值範圍為:1-200,預設值為 20。

20

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

本次請求的 ID。

D7861F61-5B61-46CE-A47C-6B19****5EB0

RuleLabels

array<object>

BOT 管理的規則標籤清單。

object

LabelKey

string

BOT 管理的規則標籤。

malicious_crawler_python

SubScene

string

規則所屬的 Bot 管理防護場景集合,多個場景以英文逗號(,)分隔。取值:

  • web:表示 Web 防護場景。

  • app:表示 App 防護場景。

web,app

BotBehavior

string

規則標籤對應的爬蟲行為。

  • malicious:表示惡意爬蟲。

  • suspicious:表示疑似爬蟲。

  • normal:表示正常爬蟲。

malicious

LabelType

string

BOT 規則標籤類型。

human_machine_challenge

DefaultStatus

integer

標籤規則預設狀態。

  • 1:表示規則開啟。

  • 0:表示規則關閉。

1

DefaultAction

string

預設執行動作。

  • block:表示攔截。

  • monitor:表示觀察。

  • js:表示 JS 驗證。

  • captcha:表示滑塊驗證。

  • captcha_strict:表示嚴格滑塊驗證。

  • bypass:表示放行。

block

DefaultConfig

string

標籤對應的預設設定。

{"crawlerStatusMap":{"360":1,"bytedance":1}}

LabelStatus

string

標籤狀態。

  • online:表示線上。

  • wait_offline:表示待下線。

online

NextToken

string

下一頁查詢憑證(Token),如果有下一頁,則該欄位會有回傳值。

說明

只要該參數有回傳值,即表示還有下一頁。您可以將回傳的 NextToken 作為請求參數再次取得下一頁的資料,直到無回傳值為止,即表示已獲取所有資料。

AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS

MaxResults

integer

分頁查詢時每頁筆數。取值範圍為:1-200,預設值為 20。

20

TotalCount

integer

回傳結果的總數。

8

樣本

正常返回樣本

JSON格式

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19****5EB0",
  "RuleLabels": [
    {
      "LabelKey": "malicious_crawler_python",
      "SubScene": "Web,app",
      "BotBehavior": "malicious",
      "LabelType": "human_machine_challenge",
      "DefaultStatus": 1,
      "DefaultAction": "block",
      "DefaultConfig": "{\"crawlerStatusMap\":{\"360\":1,\"bytedance\":1}}",
      "LabelStatus": "online"
    }
  ],
  "NextToken": "AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS",
  "MaxResults": 20,
  "TotalCount": 8
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情