DescribeMetricList - 查詢指定雲產品的指定監控項的監控資料 - Cloud Monitor

介面說明

使用限制

調用 DescribeMetricLast、DescribeMetricList、DescribeMetricData 和 DescribeMetricTop 的介面，有 100 萬次/月免費額度（總計），當免費額度用完且您沒有開通基礎CloudMonitor隨用隨付時，將無法正常使用該 API。如果您已開通基礎CloudMonitor的隨用隨付，當免費調用額度用完時，該 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。單位：秒。說明如果不設定統計周期，則按照註冊監控項時申請的上報周期來查詢監控資料。每個雲產品的監控項（`MetricName`）的統計周期不同。更多資訊，請參見雲產品監控項。	60
StartTime	string	否	開始時間。支援的格式： Unix 時間戳記：從 1970 年 1 月 1 日開始所經過的毫秒數。 Format 格式：YYYY-MM-DD hh:mm:ss。說明開始和結束時間執行的是左開右閉的模式，StartTime 不能等於或大於 EndTime。 StartTime 和 EndTime 之間的間隔小於等於 31 天。	2019-01-30 00:00:00
EndTime	string	否	結束時間。支援的格式： Unix 時間戳記：從 1970 年 1 月 1 日開始所經過的毫秒數。 Format 格式：YYYY-MM-DD hh:mm:ss。說明 StartTime 和 EndTime 之間的間隔小於等於 31 天。	2019-01-30 00:10:00
Dimensions	string	否	指定資源的監控維度。格式：`key:value`索引值對形式的集合，例如：`{"userId":"120886317861**"}`和`{"instanceId":"i-2ze2d6j5uhg20x47**"}`。說明單次請求最多支援批量查詢 50 個執行個體。	[{"instanceId":"i-2ze2d6j5uhg20x47****"}]
NextToken	string	否	分頁遊標標識。說明如果不設定該參數，則表示擷取第一頁的資料。當該參數有傳回值時，說明還有下一頁，您可以將返回的 NextToken 作為參數再次請求獲得下一頁的資料，直到返回為 Null 為止，表示擷取到了所有的資料。	15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****
Length	string	否	每頁顯示的記錄條數，用於分頁查詢。說明單次請求 Length 的最大值為 1440。	1000
Express	string	否	查詢出的現有結果進行Realtime Compute的運算式。說明目前僅支援 groupby，類似資料庫的 groupby 語句。	{"groupby":["userId","instanceId"]}

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

返回參數

名稱	類型	描述	樣本值
	object
NextToken	string	分頁遊標標識。	15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****
RequestId	string	請求 ID。	3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42
Success	boolean	操作是否成功。取值： true：成功。 false：失敗。	true
Datapoints	string	監控資料列表。	[{"timestamp":1548777660000,"userId":"120886317861****","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]
Code	string	狀態代碼。說明 200 表示成功。	200
Message	string	錯誤資訊。	The specified resource is not found.
Period	string	時間間隔。單位：秒。取值：60、300、900。	60

樣本

正常返回樣本

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
500	InternalError	The request processing has failed due to some unknown error.
403	%s	%s
404	ResourceNotFound	The specified resource is not found.	未找到指定資源。

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

變更歷史

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