使用DescribeMetricLast查詢指定監控項的最新監控資料-CloudMonitor-阿里雲 - Cloud Monitor

介面說明

使用限制

呼叫 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 監控項目 CPUUtilization 的最新監控資料。返回結果顯示，目前帳號 123456789876**** 下執行個體 i-abcdefgh12**** 間隔 60 秒的最大值為 100、最小值為 93.1、平均值為 99.52。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cms:QueryMetricLast

get

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
Namespace	string	是	雲端產品的資料命名空間。關於雲端產品的資料命名空間，請參見雲端產品監控項目。	acs_ecs_dashboard
MetricName	string	是	雲端產品的監控項目名稱。關於監控項目名稱，請參見雲端產品監控項目。	CPUUtilization
Period	string	否	監控資料的統計週期。取值：15、60、900 和 3600。單位：秒。說明如果不設定統計週期，則按照註冊監控項目時申請的上報週期來查詢監控資料。 - 每個雲端產品的監控項目（`MetricName`）的統計週期不同。更多資訊，請參見雲端產品監控項目中目標雲端產品指標列表頁面中的 `Min Periods` 欄位。	60
StartTime	string	否	開始時間。支援兩種格式：1. Unix 時間戳記字串，單位為毫秒（ms），即從 1970-01-01 00:00:00 UTC 起經過的毫秒數；2. ISO 8601 標準時間字串，格式為 YYYY-MM-DDThh:mm:ssZ，時區為 UTC。說明查詢範圍執行左開右閉模式，StartTime 不能等於或大於 EndTime，且兩者間隔需小於等於 31 天。	2019-01-31 10:00:00
EndTime	string	否	查詢監控項目的結束時間。系統將根據資料精度自動限制查詢的起始時間（即查詢視窗大小）：秒級資料：最大查詢跨度為 20 分鐘（起始時間 = Max(startTime, EndTime - 20min)）；分鐘級資料：最大查詢跨度為 2 小時（起始時間 = Max(startTime, EndTime - 2h)）；小時級資料：最大查詢跨度為 2 天（起始時間 = Max(startTime, EndTime - 2d)）。說明若傳入的 startTime 早於上述限制時間，系統將自動使用限制時間作為實際查詢起點。	2019-01-31 10:10:00
Dimensions	string	否	指定資源的監控維度。格式：`key:value` 鍵值對形式的集合，例如：`{"userId":"120886317861**"}` 和 `{"instanceId":"i-2ze2d6j5uhg20x47**"}`。說明單次請求最多支援批次查詢 50 個執行個體。	[{"instanceId":"i-2ze2d6j5uhg20x47****"}]
NextToken	string	否	分頁遊標的識別碼。如果符合查詢條件的返回結果超過了分頁大小，則會返回這個分頁遊標。如果需要獲取下一頁資料，將返回的遊標值作為請求參數即可，直到無遊標值返回，表示已經獲取了全部資料。	15761432850009dd70bb64cff1f0fff6c0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****
Length	string	否	返回監控資料的每頁大小，用於分頁查詢。預設值：1000，即每頁 1000 條監控資料。說明單次請求 Length 的最大值為 1440。	1000
Express	string	否	對現有查詢結果進行即時運算的表達式。	{"groupby":["userId","instanceId"]}

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

返回參數

名稱	類型	描述	樣本值
	object
NextToken	string	分頁遊標識別碼。	xxxxxx
RequestId	string	請求 ID。	021472A6-25E3-4094-8D00-BA4B6A5486C3
Success	boolean	操作是否成功。取值： true：成功。 false：失敗。	true
Datapoints	string	監控資料列表。	[{"timestamp":1548777660000,"userId":"123456789876**","instanceId":"i-abcdefgh12**","Minimum":93.1,"Average":99.52,"Maximum":100}]
Code	string	狀態碼。說明 200 表示成功。	200
Message	string	錯誤訊息。	The specified resource is not found.
Period	string	時間間隔。單位：秒。	60

樣本

正常返回樣本

JSON格式

{
  "NextToken": "xxxxxx",
  "RequestId": "021472A6-25E3-4094-8D00-BA4B6A5486C3",
  "Success": true,
  "Datapoints": "[{\"timestamp\":1548777660000,\"userId\":\"123456789876****\",\"instanceId\":\"i-abcdefgh12****\",\"Minimum\":93.1,\"Average\":99.52,\"Maximum\":100}]",
  "Code": "200",
  "Message": "The specified resource is not found.",
  "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.	指定資源%s不存在。

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

變更歷史

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