調用DescribeMetricList接口查詢指定云產品的指定監控項的監控數據。
接口說明
使用限制
- 調用 DescribeMetricLast、DescribeMetricList、DescribeMetricData 和 DescribeMetricTop 的接口,有 100 萬次/月免費額度(總計),當免費額度用完且您沒有開通基礎云監控按量計費時,將無法正常使用該 API。如果您已開通基礎云監控的按量計費,當免費調用額度用完時,該 API 仍然可以正常使用,超出免費額度部分將自動按使用量計費。開通方法詳見開通按量計費。
- 單個 API 的調用次數限制為 50 次/秒。一個阿里云賬號及該賬號下的 RAM 用戶共用 50 次/秒。
說明
當您調用 API 時,如果返回信息
Throttling.User
或Request was denied due to user flow control
,則說明該 API 被限流。處理方法,請參見如何處理查詢 API 限流問題。
注意事項
各云產品監控數據的存儲時長與Period
(統計周期)有關,Period
越大,查詢的監控數據越稀疏,監控數據的存儲時間越長,具體關系如下:
Period
小于 60 秒,存儲時長為 7 天。Period
等于 60 秒,存儲時長為 31 天。Period
等于大于 300 秒,存儲時長為 91 天。
使用說明
本文將提供一個示例,查詢云產品acs_ecs_dashboard
的監控項cpu_idle
的監控數據。返回結果顯示,當前賬號120886317861****
下實例i-abcdefgh12****
間隔 60 秒的最大值為 100、最小值為 93.1、平均值為 99.52。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cms:QueryMetricList | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Namespace | string | 是 | 云產品的數據命名空間。 關于云產品的數據命名空間,請參見云產品監控項。 | acs_ecs_dashboard |
MetricName | string | 是 | 云產品的監控項名稱。 關于監控項名稱,請參見云產品監控項。 | cpu_idle |
Period | string | 否 | 監控數據的統計周期。 取值:15、60、900 和 3600。 單位:秒。 說明
| 60 |
StartTime | string | 否 | 開始時間。支持的格式:
說明
| 2019-01-30 00:00:00 |
EndTime | string | 否 | 結束時間。支持的格式:
說明
StartTime 和 EndTime 之間的間隔小于等于 31 天。
| 2019-01-30 00:10:00 |
Dimensions | string | 否 | 指定資源的監控維度。 格式: 說明
單次請求最多支持批量查詢 50 個實例。
| [{"instanceId":"i-2ze2d6j5uhg20x47****"}] |
NextToken | string | 否 | 分頁游標標識。 說明
如果不設置該參數,則表示獲取第一頁的數據。當該參數有返回值時,說明還有下一頁,您可以將返回的 NextToken 作為參數再次請求獲得下一頁的數據,直到返回為 Null 為止,表示獲取到了所有的數據。
| 15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8**** |
Length | string | 否 | 每頁顯示的記錄條數,用于分頁查詢。 說明
單次請求 Length 的最大值為 1440。
| 1000 |
Express | string | 否 | 查詢出的現有結果進行實時計算的表達式。 說明
目前僅支持 groupby,類似數據庫的 groupby 語句。
| {"groupby":["userId","instanceId"]} |
關于公共請求參數的詳情,請參見公共參數。
返回參數
示例
正常返回示例
JSON
格式
{
"NextToken": "15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****",
"RequestId": "3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42",
"Success": true,
"Datapoints": "[{\"timestamp\":1548777660000,\"userId\":\"120886317861****\",\"instanceId\":\"i-abc\",\"Minimum\":9.92,\"Average\":9.92,\"Maximum\":9.92}]",
"Code": "200",
"Message": "The specified resource is not found.",
"Period": "60"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | %s | %s | - |
404 | ResourceNotFound | The specified resource is not found. | 未找到指定資源。 |
500 | InternalError | The request processing has failed due to some unknown error. | - |
500 | InternalError | %s | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-03-10 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |