查詢一台 ECS 執行個體所有相關的監控資訊。返回的監控內容包括 ECS 執行個體的 CPU 使用率、接收的資料流量、發送的資料流量、網路流量、平均頻寬。當返回資訊中缺少部分內容時,可能是由於系統沒有獲取到相應的資訊,比如當時執行個體處於 已停止(Stopped
)狀態。
描述
調用該介面時,您需要注意:
-
每次最多返回 400 條監控資料,如果指定的參數 (
EndTime
StartTime
)/Peroid
> 400 時,則返回錯誤。 -
單次最多能查詢近 30 天內的監控資訊,如果指定的參數
StartTime
超過 30 天,則返回錯誤。
請求參數
名稱 | 類型 | 是否必需 | 描述 |
---|---|---|---|
Action | String | 是 | 系統規定參數。取值:DescribeInstanceMonitorData |
InstanceId | String | 是 | 待查詢的執行個體 ID。 |
StartTime | String | 是 | 獲取資料的起始時間點。按照 ISO8601 表示,並需要使用 UTC 時間,格式為:YYYY-MM-DDThh:mm:ssZ。如果指定的秒(ss )不是 00,則自動換算為下一分鐘。 |
EndTime | String | 是 | 獲取資料的結束時間點。按照 ISO8601 標準表示,並需要使用 UTC 時間,格式為:YYYY-MM-DDThh:mm:ssZ。 如果指定的秒(ss )不是 00,則自動換算為下一分鐘。 |
Period | Integer | 否 | 獲取監控資料的間隔時間,單位為秒。取值範圍:
|
返回參數
名稱 | 類型 | 描述 |
---|---|---|
MonitorData | InstanceMonitorDataType | 執行個體的監控資料集合 |
樣本
請求樣本
https://ecs.aliyuncs.com/?Action=DescribeInstanceMonitorData
&InstanceId=i-instnace1
&StartTime=2014-10-29T23:00:00Z
&EndTime=2014-10-30T08:00:00Z
&<公共請求參數>
返回樣本
XML 格式
<DescribeInstanceMonitorDataResponse>
<RequestId>C8B26B44-0189-443E-9816-D951F59623A9</RequestId>
<MonitorData>
<InstanceMonitorData>
<InstanceId>Bc0102-23xYm09</InstanceId>
<CPU>2</CPU>
<IntranetRX>122</IntranetRX>
<IntranetTX>343</IntranetTX>
<IntranetFlow>675</IntranetFlow>
<IntranetBandwidth>10</IntranetBandwidth>
<InternetRX>122</InternetRX>
<InternetTX>343</InternetTX>
<InternetFlow>675</InternetFlow>
<InternetBandwidth>10</InternetBandwidth>
<IOPSRead>1000</IOPSRead>
<IOPSWrite>200</IOPSWrite>
<BPSRead>1000</BPSRead>
<BPSWrite>200</BPSWrite>
<TimeStamp>2010-01-21T09:50:23Z</TimeStamp>
</InstanceMonitorData>
</MonitorData>
</DescribeInstanceMonitorDataResponse>
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"
}]
}
}
錯誤碼
以下為本介面特有的錯誤碼。更多錯誤碼,請訪問 API 錯誤中心。
錯誤碼 | 錯誤資訊 | HTTP 狀態碼 | 說明 |
---|---|---|---|
InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 404 | 指定的 InstanceId 不存在。 |
InvalidStartTime.Malformed | The specified parameter “StartTime” is not valid. | 400 | 指定的 StartTime 格式不正確。 |
InvalidEndTime.Malformed | The specified parameter “EndTime” is not valid. | 400 | 指定的 EndTime 格式不正確。 |
InvalidPeriod.ValueNotSupported | The specified parameter “Period” is not valid. | 400 | 指定的 Period 不合法。 |
InvalidStartTime.TooEarly | The specified parameter “StartTime” is too early. | 400 | 指定的 StartTime 早於 30 天,單次最多能查詢近 30 天內的監控資訊。 |
InvalidParameter.TooManyDataQueried | Too many data queried. | 400 | 查詢的資料量過多,每次最多查詢 400 條監控資料。 |
Throttling | You have made too many requests within a short time; your request is denied due to request throttling. | 400 | 請求被流控,請稍後再試。 |