DescribeInstanceMonitorData - 查詢執行個體監控資料 - Elastic Compute Service

調用DescribeInstanceMonitorData查詢一台ECS執行個體的監控資訊。可查詢的指標包括ECS執行個體的vCPU使用率、突發效能執行個體積分、接收的資料流量、發送的資料流量、平均頻寬等。

介面說明

調用該介面時，您需要注意：

一次最多返回 400 條資料，需滿足（EndTime–StartTime）/Period小於等於 400 的條件限制，即返回參數TotalCount不能超過 400，否則將返回InvalidParameter.TooManyDataQueried的錯誤提示。
一次最多能查詢近 30 天內的監控資訊，即指定的參數StartTime距今不能超過 30 天。
當返回資訊中缺少部分內容時，可能是系統沒有擷取到相應的資訊。例如，當時執行個體處於已停止（Stopped）狀態。
該介面暫無法擷取 EBM 彈性裸金屬執行個體的 CPU 基礎監控資訊，您可通過安裝CloudMonitor外掛程式擷取 CPU 監控資訊。具體操作，請參見安裝CloudMonitor外掛程式。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:DescribeInstanceMonitorData

get

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	待查詢的執行個體 ID。	i-bp1a36962lrhj4ab****
StartTime	string	是	擷取資料的起始時間點。按照ISO 8601標準表示，並使用 UTC +0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。如果指定的秒（`ss`）不是`00`，則自動換算為下一分鐘。	2014-10-29T23:00:00Z
EndTime	string	是	擷取資料的結束時間點。按照ISO 8601標準表示，並使用 UTC +0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。如果指定的秒（`ss`）不是`00`，則自動換算為下一分鐘。	2014-10-30T08:00:00Z
Period	integer	否	擷取監控資料的間隔時間，單位：秒。取值範圍： 60。 600。 3600。預設值：60。	60

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
MonitorData	object
InstanceMonitorData	array<object>	執行個體的監控資料集合。
	object
CPUCreditBalance	number	突發效能執行個體積分總數。	120
BPSRead	integer	執行個體雲端硬碟（包括系統硬碟和資料盤）的讀頻寬，單位：Byte/s。	1000
InternetTX	integer	在查詢監控資訊時（`TimeStamp`），執行個體在指定的間隔時間（`Period`）內發送的公網資料流量。單位：kbits。	343
CPU	integer	執行個體 vCPU 的使用比例，單位：百分比（%）。	2
CPUCreditUsage	number	突發效能執行個體已使用的積分數。	30
IOPSWrite	integer	執行個體雲端硬碟（包括系統硬碟和資料盤）的 I/O 寫操作，單位：次/s。	200
IntranetTX	integer	在查詢監控資訊時（`TimeStamp`），執行個體在指定的間隔時間（`Period`）內發送的內網資料流量。單位：kbits。	343
InstanceId	string	執行個體 ID。	i-bp1a36962lrhj4****
BPSWrite	integer	執行個體雲端硬碟（包括系統硬碟和資料盤）的寫頻寬，單位：Byte/s。	13585
CPUNotpaidSurplusCreditUsage	number	超額未支付積分。	0.5
CPUAdvanceCreditBalance	number	超額積分（突發效能執行個體積分超限部分）。	0.4
IOPSRead	integer	執行個體雲端硬碟（包括系統硬碟和資料盤）的 I/O 讀操作，單位：次/s。	1000
InternetBandwidth	integer	執行個體的公網頻寬，單位時間內的網路流量，單位：kbits/s。	10
InternetRX	integer	在查詢監控資訊時（`TimeStamp`），執行個體在指定的間隔時間（`Period`）內接收的公網資料流量。單位：kbits。	122
TimeStamp	string	查詢監控資訊的時間戳記。	2014-10-30T05:00:00Z
IntranetRX	integer	在查詢監控資訊時（`TimeStamp`），執行個體在指定的間隔時間（`Period`）內接收的內網資料流量。單位：kbits。	122
IntranetBandwidth	integer	執行個體的內網頻寬，單位時間內的網路流量，單位：kbits/s。	10

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "MonitorData": {
    "InstanceMonitorData": [
      {
        "CPUCreditBalance": 120,
        "BPSRead": 1000,
        "InternetTX": 343,
        "CPU": 2,
        "CPUCreditUsage": 30,
        "IOPSWrite": 200,
        "IntranetTX": 343,
        "InstanceId": "i-bp1a36962lrhj4****",
        "BPSWrite": 13585,
        "CPUNotpaidSurplusCreditUsage": 0.5,
        "CPUAdvanceCreditBalance": 0.4,
        "IOPSRead": 1000,
        "InternetBandwidth": 10,
        "InternetRX": 122,
        "TimeStamp": "2014-10-30T05:00:00Z",
        "IntranetRX": 122,
        "IntranetBandwidth": 10
      }
    ]
  }
}

異常返回樣本

JSON格式

{
    "RequestId": "C8B26B44-0189-443E-9816-D951F59623A9",
    "MonitorData": {
        "InstanceMonitorData": [{
            "InstanceId": "Bc0102-23xYm09",
            "CPU": 0,
            "IntranetRX": 122,
            "IntranetTX": 343,
            "IntranetFlow": 675,
            "IntranetBandwidth": 10,
            "InternetRX": 122,
            "InternetTX": 343,
            "InternetFlow": 675,
            "InternetBandwidth": 10,
            "IOPSRead": 1000,
            "IOPSWrite": 200,
            "BPSRead": 1000,
            "BPSWrite": 200,
            "TimeStamp": "2010-01-21T09:50:23Z"
        }]
    }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidStartTime.Malformed	The specified parameter "StartTime" is not valid.	指定的StartTime參數不符合規範。
400	InvalidEndTime.Malformed	The specified parameter "EndTime" is not valid.	傳入的參數EndTime不符合規則。
400	InvalidPeriod.ValueNotSupported	The specified parameter "Period" is not valid.
400	InvalidStartTime.TooEarly	The specified parameter "StartTime" is too early.
400	InvalidParameter.TooManyDataQueried	Too many data queried.	監控資料節點超出範圍。
400	Throttling	Request was denied due to request throttling.	請求被流控。
400	InvalidStartTime.ValueNotSupported	The specified parameter StartTime is later than EndTime.	結束時間不能早於開始時間。
500	InternalError	The request processing has failed due to some unknown error.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	指定的執行個體ID無效。

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

變更歷史

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