全部產品
Search

搜尋本產品

    Cloud Monitor：DescribeMetricRuleBlackList

    文件中心

    Cloud Monitor：DescribeMetricRuleBlackList

    更新時間：Jul 21, 2026

    查詢警示黑名單策略清單。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cms:DescribeMetricRuleBlackList

    list

    *全部資源。

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Namespace

    string

    否

    雲端服務的資料命名空間。

    關於雲端服務的命名空間，請參見雲端服務監控項目。

    acs_ecs_dashboard
    PageNumber

    integer

    否

    目前頁碼。

    預設值：1。

    1
    PageSize

    integer

    否

    每頁顯示的記錄筆數。

    預設值：10。

    100
    Order

    integer

    否

    查詢結果按時間的排序方式。取值：

    0（升序 ASC）。

    1（降序 DESC，預設值）。

    1
    Category

    string

    否

    雲端服務分類。例如：Redis 有 kvstore_standard（標準版）、kvstore_sharding（叢集版）和 kvstore_splitrw（讀寫分離版）等。

    ecs
    Ids

    array

    否

    警示黑名單策略的 ID 清單。

    string

    否

    警示黑名單策略的 ID。

    a9ad2ac2-3ed9-11ed-b878-0242ac12****
    Name

    string

    否

    警示黑名單策略名稱。

    此參數支援模糊查詢。

    Blacklist-01
    ScopeType

    string

    否

    警示黑名單策略的生效範圍。取值：

    • USER：警示黑名單策略僅在目前阿里雲帳號中生效。

    • GROUP：警示黑名單策略在指定應用程式分組中生效。

    USER
    IsEnable

    boolean

    否

    警示黑名單策略的啟用狀態。取值：

    • true：啟用。

    • false：停用。

    true
    InstanceIds

    array

    否

    警示黑名單策略中的執行個體 ID 清單。

    N 的取值範圍：0~10。

    string

    否

    警示黑名單策略中的執行個體 ID。

    i-2ze2d6j5uhg20x47****

    關於公用請求參數的詳細資訊，請參見公用參數。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    無。

    Code

    string

    狀態碼。

    說明

    200 表示成功。

    200
    Message

    string

    錯誤訊息。

    The Request is not authorization.
    RequestId

    string

    請求 ID。

    D63E76CB-29AA-5B9F-88CE-400A6F28D428
    Total

    integer

    警示黑名單策略的總筆數。

    1
    Success

    boolean

    操作是否成功。取值：

    • true：成功。

    • false：失敗。

    true
    DescribeMetricRuleBlackList

    array<object>

    警示黑名單策略清單。

    array<object>

    警示黑名單策略清單。

    EffectiveTime

    string

    警示黑名單策略的生效時間範圍。

    格式為 HH:mm-HH:mm（24 小時制），時區預設為 UTC+8（北京時間）。範例值 "00:00-23:59" 表示全天生效。

    00:00-23:59
    UpdateTime

    string

    修改警示黑名單策略的時間戳記。

    單位：毫秒。

    1665718373000
    CreateTime

    string

    建立警示黑名單策略的時間戳記。

    單位：毫秒。

    1665714561000
    ScopeType

    string

    警示黑名單策略的生效範圍。取值：

    • USER：警示黑名單策略僅在目前阿里雲帳號中生效。

    • GROUP：警示黑名單策略在指定應用程式分組中生效。

    USER
    IsEnable

    boolean

    警示黑名單策略的狀態。取值：

    • true：啟用。

    • false：停用。

    true
    Namespace

    string

    雲端服務的資料命名空間。

    acs_ecs_dashboard
    Category

    string

    雲端服務分類。例如：Redis 有 kvstore_standard（標準版）、kvstore_sharding（叢集版）和 kvstore_splitrw（讀寫分離版）等。

    ecs
    EnableEndTime

    integer

    警示黑名單策略的開始時間戳記。

    單位：毫秒。

    1640608200000
    Name

    string

    警示黑名單策略的名稱。

    Blacklist-01
    EnableStartTime

    integer

    警示黑名單策略的結束時間戳記。

    單位：毫秒。

    1640237400000
    Id

    string

    警示黑名單策略的 ID。

    93514c96-ceb8-47d8-8ee3-93b6d98b****
    Metrics

    array<object>

    執行個體中的監控指標。

    object

    執行個體中的監控指標。

    Resource

    string

    執行個體的擴充維度資訊。例如：{"device":"C:"}，表示對雲端伺服器 ECS 執行個體下的所有 C 磁碟套用黑名單策略。

    [{"device":"C:"}]
    MetricName

    string

    監控指標名稱。

    disk_utilization
    Instances

    array

    警示黑名單策略中指定雲端服務的執行個體清單。

    string

    警示黑名單策略中指定雲端服務的執行個體清單。

    i-rj99xc6cptkk64ml****
    ScopeValue

    array

    應用程式分組 ID 清單。

    string

    應用程式分組 ID 清單。格式為 JSON Array。

    說明

    僅當 ScopeType 為 GROUP 時，顯示此參數。

    ["67****","78****"]

    樣本

    正常返回樣本

    JSON格式

    {
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "D63E76CB-29AA-5B9F-88CE-400A6F28D428",
  "Total": 1,
  "Success": true,
  "DescribeMetricRuleBlackList": [
    {
      "EffectiveTime": "00:00-23:59",
      "UpdateTime": "1665718373000",
      "CreateTime": "1665714561000",
      "ScopeType": "USER",
      "IsEnable": true,
      "Namespace": "acs_ecs_dashboard",
      "Category": "ecs",
      "EnableEndTime": 1640608200000,
      "Name": "Blacklist-01",
      "EnableStartTime": 1640237400000,
      "Id": "93514c96-ceb8-47d8-8ee3-93b6d98b****",
      "Metrics": [
        {
          "Resource": "[{\"device\":\"C:\"}]",
          "MetricName": "disk_utilization"
        }
      ],
      "Instances": [
        "i-rj99xc6cptkk64ml****"
      ],
      "ScopeValue": [
        "[\"67****\",\"78****\"]"
      ]
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 ParameterInvalid Illegal parameters.
    500 InternalError The request processing has failed due to some unknown error.
    403 AccessForbidden User not authorized to operate on the specified resource.
    404 ResourceNotFound The specified resource is not found. 指定資源%s不存在。
    409 ResourceConflict Concurrent modification of resources.
    409 ResourceExist Resources already exist.

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

    變更歷史

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