全部產品
Search

搜尋本產品

    Security Center：DescribeAntiBruteForceRules

    文件中心

    Security Center：DescribeAntiBruteForceRules

    更新時間：Jun 15, 2026

    查詢您已建立的防暴力破解規則。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    yundun-sas:DescribeAntiBruteForceRules

    get

    *AntiBruteForceRule

    acs:yundun-sas:{#regionId}:{#accountId}:antibruteforcerule/{#AntiBruteForceRuleId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    SourceIp

    string

    否

    存取來源的 IP 位址。

    121.69.XX.XX
    Id

    integer

    否

    防暴力破解規則 ID。

    說明

    呼叫 DescribeAntiBruteForceRules 介面可以取得該參數。

    1141****
    CurrentPage

    integer

    否

    設定從返回結果的第幾頁開始顯示查詢結果。預設值為 1，表示從第 1 頁開始顯示。

    1
    PageSize

    string

    否

    分頁查詢時，顯示的每頁資料的最大筆數。

    10
    Name

    string

    否

    暴力破解規則的名稱。

    testName

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    請求返回資料。

    RequestId

    string

    本次呼叫請求的 ID，是由阿里雲為該請求生成的唯一識別碼，可用於排查和定位問題。

    4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D
    PageInfo

    object

    查詢結果的分頁資訊。

    CurrentPage

    integer

    分頁查詢時，當前頁的頁碼。

    1
    PageSize

    integer

    分頁查詢時，每頁最多顯示的資料筆數。

    20
    TotalCount

    integer

    已建立的防暴力破解規則的總數。

    2
    Count

    integer

    分頁查詢時，當前頁顯示的資料筆數。

    2
    Rules

    array<object>

    防暴力破解規則詳情列表。

    array<object>

    防暴力破解規則詳情。

    MachineCount

    integer

    設定該暴力破解防禦規則的伺服器數量。

    3
    EnableSmartRule

    boolean

    該參數已廢棄，無需關注。

    false
    FailCount

    integer

    暴力破解防禦規則生效的使用者登入的失敗次數閾值。

    15
    ForbiddenTime

    integer

    暴力破解防禦規則生效後對攻擊方 IP 禁用的時間，單位（分鐘）。

    360
    Span

    integer

    暴力破解防禦規則生效的時間閾值，單位為分鐘。例如 span 為 10，表示如果在 10 分鐘內登入失敗次數超過設定的閾值，防暴力破解規則會生效並在指定時間內攔截登入。

    10
    DefaultRule

    boolean

    當前規則是否為預設規則。取值：

    • true：是預設規則。

    • false：不是預設規則。

    說明

    設定為預設規則的防暴力破解規則會對所有未新增防禦規則的伺服器生效。

    true
    Name

    string

    暴力破解防禦規則的名稱。

    AntiBruteForceRule01
    Id

    integer

    暴力破解防禦規則的規則 ID。

    1629
    UuidList

    array

    設定該暴力破解防禦規則的伺服器的 UUID 列表。

    string

    設定該暴力破解防禦規則的伺服器的 UUID。

    uuid-018c-4ef7-89fd-988b9b0e****
    CreateTimestamp

    integer

    防暴力破解規則建立時間戳記。單位：毫秒。

    1669800181000
    ProtocolType

    object

    暴力破解規則支援攔截的協定類型。

    Rdp

    string

    RDP 攔截方式，取值：

    • on：開啟

    • off：關閉

    on
    Ssh

    string

    SSH 攔截方式，取值：

    • on：開啟

    • off：關閉

    on
    SqlServer

    string

    SqlServer 攔截方式，取值：

    • on：開啟

    • off：關閉

    off

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 2,
    "Count": 2
  },
  "Rules": [
    {
      "MachineCount": 3,
      "EnableSmartRule": false,
      "FailCount": 15,
      "ForbiddenTime": 360,
      "Span": 10,
      "DefaultRule": true,
      "Name": "AntiBruteForceRule01",
      "Id": 1629,
      "UuidList": [
        "uuid-018c-4ef7-89fd-988b9b0e****"
      ],
      "CreateTimestamp": 1669800181000,
      "ProtocolType": {
        "Rdp": "on",
        "Ssh": "on",
        "SqlServer": "off"
      }
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    500 ServerError ServerError
    403 NoPermission caller has no permission

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

    變更歷史

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