全部產品
Search

搜尋本產品

    Cloud Monitor：DescribeMetricTop - 查詢排序後的最新監控資料

    文件中心

    Cloud Monitor：DescribeMetricTop - 查詢排序後的最新監控資料

    更新時間：Dec 24, 2025

    調用DescribeMetricTop介面先查詢指定雲產品的指定監控項的最新監控資料，再查詢該監控項排序後的監控資料。

    介面說明

    使用限制

    • 調用 DescribeMetricLast、DescribeMetricList、DescribeMetricData 和 DescribeMetricTop 的介面，有 100 萬次/月免費額度（總計），當免費額度用完且您沒有開通基礎CloudMonitor隨用隨付時，將無法正常使用該 API。如果您已開通基礎CloudMonitor的隨用隨付，當免費調用額度用完時，該 API 仍然可以正常使用，超出免費額度部分將自動按使用量計費。開通方法詳見開通隨用隨付。

    • 單個 API 的調用次數限制為 10 次/秒。一個阿里雲帳號及該帳號下的 RAM 使用者共用 10 次/秒。

    注意事項

    各雲產品監控資料的儲存時間長度與Period（統計周期）有關，Period越大，查詢的監控資料越稀疏，監控資料的儲存時間越長，具體關係如下：

    • Period小於 60 秒，儲存時間長度為 7 天。

    • Period等於 60 秒，儲存時間長度為 31 天。

    • Period大於等於 300 秒，儲存時間長度為 91 天。

    使用說明

    本文將提供一個樣本，查詢雲端服務acs_ecs_dashboard監控項cpu_idle在最近 60 秒的監控資料，並對監控資料的Average從大到小排序。

    調試

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

    調試

    授權資訊

    當前API暫無授權資訊透出。

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Period

    string

    否

    監控資料的統計周期。

    取值：15、60、900 和 3600。

    單位：秒。

    說明

    • 如果不設定統計周期，則按照註冊監控項時申請的上報周期來查詢監控資料。

    • 每個雲產品的監控項（MetricName）的統計周期不同。更多資訊，請參見雲產品監控項。

    60
    Namespace

    string

    是

    雲產品的資料命名空間。

    關於雲產品的資料命名空間，請參見雲產品監控項。

    acs_ecs_dashboard
    MetricName

    string

    是

    雲產品的監控項名稱。

    關於監控項名稱，請參見雲產品監控項。

    cpu_idle
    StartTime

    string

    否

    查詢監控資料的開始時間。

    • 當您未設定StartTime和EndTime時，查詢目前時間最近一個統計周期Period的監控資料。

    • 當您同時設定StartTime和EndTime時，查詢指定時間段內距離EndTime最近一個統計周期Period的監控資料。具體如下：

      • 當Period設定為 15 秒時，指定時間段必須小於或等於 20 分鐘。例如：StartTime 為 2021-05-08 08:10:00，EndTime 為 2021-05-08 08:30:00，統計距離 2021-05-08 08:30:00 最近一個 15 秒的監控資料。

      • 當Period設定為 60 秒或 900 秒時，指定時間段必須小於或等於 2 小時。例如：Period 為 60 秒，StartTime 為 2021-05-08 08:00:00，EndTime 為 2021-05-08 10:00:00，統計距離 2021-05-08 10:00:00 最近一個 60 秒的監控資料。

      • 當Period設定為 3600 秒時，指定時間段必須小於或等於 2 天。例如：StartTime 為 2021-05-08 08:00:00，EndTime 為 2021-05-10 08:00:00，統計距離 2021-05-10 08:00:00 最近一個 3600 秒的監控資料。

    開始時間支援的格式：

    • Unix 時間戳記：從 1970 年 1 月 1 日開始所經過的毫秒數。

    • Format 格式：YYYY-MM-DDThh:mm:ssZ。

    說明

    • StartTime如果設定過早，則無效。

    • 建議您使用 Unix 時間戳記，避免時區的問題。

    2021-05-08 08:00:00
    EndTime

    string

    否

    查詢監控資料的結束時間。

    • 當您未設定StartTime和EndTime時，查詢目前時間最近一個統計周期Period的監控資料。

    • 當您同時設定StartTime和EndTime時，查詢指定時間段內距離EndTime最近一個統計周期Period的監控資料。具體如下：

      • 當Period設定為 15 秒時，指定時間段必須小於或等於 20 分鐘。例如：StartTime 為 2021-05-08 08:10:00，EndTime 為 2021-05-08 08:30:00，統計距離 2021-05-08 08:30:00 最近一個 15 秒的監控資料。

      • 當Period設定為 60 秒或 900 秒時，指定時間段必須小於或等於 2 小時。例如：Period 為 60 秒，StartTime 為 2021-05-08 08:00:00，EndTime 為 2021-05-08 10:00:00，統計距離 2021-05-08 10:00:00 最近一個 60 秒的監控資料。

      • 當Period設定為 3600 秒時，指定時間段必須小於或等於 2 天。例如：StartTime 為 2021-05-08 08:00:00，EndTime 為 2021-05-10 08:00:00，統計距離 2021-05-10 08:00:00 最近一個 3600 秒的監控資料。

    結束時間支援的格式：

    • Unix 時間戳記：從 1970 年 1 月 1 日開始所經過的毫秒數。

    • Format 格式：YYYY-MM-DDThh:mm:ssZ。

    說明

    建議您使用 Unix 時間戳記，避免時區的問題。

    2021-05-08 10:00:00
    Dimensions

    string

    否

    指定資源的監控維度。

    格式：key:value索引值對形式的集合，例如：{"userId":"120886317861****"}和{"instanceId":"i-2ze2d6j5uhg20x47****"}。

    說明

    單次請求最多支援批量查詢 50 個執行個體。

    [{"instanceId": "i-2ze2d6j5uhg20x47****"}]
    Orderby

    string

    是

    排序欄位，即按該欄位進行排序。取值：

    • Average：平均值。

    • Minimum：最小值。

    • Maximum：最大值。

    Average
    OrderDesc

    string

    否

    排序方式。取值：

    • true：由小到大排序。

    • false（預設值）：由大到小排序。

    false
    Length

    string

    否

    每頁顯示的記錄條數。

    用於分頁查詢，預設值：10。

    說明

    單次請求 Length 的最大值為 1440。

    10
    Express

    string

    否

    對查詢出的現有結果進行Realtime Compute的運算式。

    說明

    目前僅支援groupby（類似資料庫的 groupby 語句）。

    {"groupby":["userId","instanceId"]}

    關於公用請求參數的詳情，請參見公用參數。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Code

    string

    狀態代碼。

    說明

    200 表示成功。

    200
    Message

    string

    錯誤資訊。

    The specified resource is not found.
    RequestId

    string

    請求 ID。

    3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42
    Datapoints

    string

    監控資料列表。

    [{\"order\":1,\"timestamp\":1620287520000,\"userId\":\"120886317861****\",\"instanceId\":\"i-j6ccf7d5fn335qpo****\",\"Average\":99.92,\"Minimum\":99.5,\"Maximum\":100.0,\"_count\":1.0},{\"order\":2,\"timestamp\":1620287520000,\"userId\":\"120886317861****\",\"instanceId\":\"i-0xii2bvf42iqvxbp****\",\"Average\":99.91,\"Minimum\":99.0,\"Maximum\":100.0,\"_count\":1.0}]
    Period

    string

    監控資料的統計周期。單位：秒。取值：15、60、900 和 3600。

    60

    樣本

    正常返回樣本

    JSON格式

    {
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42",
  "Datapoints": "[{\\\"order\\\":1,\\\"timestamp\\\":1620287520000,\\\"userId\\\":\\\"120886317861****\\\",\\\"instanceId\\\":\\\"i-j6ccf7d5fn335qpo****\\\",\\\"Average\\\":99.92,\\\"Minimum\\\":99.5,\\\"Maximum\\\":100.0,\\\"_count\\\":1.0},{\\\"order\\\":2,\\\"timestamp\\\":1620287520000,\\\"userId\\\":\\\"120886317861****\\\",\\\"instanceId\\\":\\\"i-0xii2bvf42iqvxbp****\\\",\\\"Average\\\":99.91,\\\"Minimum\\\":99.0,\\\"Maximum\\\":100.0,\\\"_count\\\":1.0}]",
  "Period": "60"
}

    錯誤碼

    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. 未找到指定資源。

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

    變更歷史

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