調用DescribeDiskMonitorData接口,并可以指定DiskId、StartTime、EndTime等參數,查詢一塊云盤在指定時間內的使用信息。
接口說明
可查詢云盤使用信息包括讀 IOPS、寫 IOPS、讀帶寬(B/s)、寫帶寬(B/s)、讀時延(μs)以及寫時延(μs)。
調用該接口時,您需要注意:
-
只能查詢狀態為使用中(
In_use
)的云盤使用信息。更多詳情,請參見普通云盤狀態表。說明 若查詢的信息中出現內容缺失,是因為無法獲取該段時間的使用信息,即云盤狀態不是使用中(In_use
)。 -
一次最多返回 400 條數據,需滿足
(EndTime–StartTime)/Period
小于等于 400 的條件限制,即返回參數TotalCount
不能超過 400,否則將返回InvalidParameter.TooManyDataQueried
的錯誤提示。 -
一次最多能查詢近 30 天內的監控信息,即指定的參數
StartTime
距今不能超過 30 天。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ecs:DescribeDiskMonitorData | get | *Disk acs:ecs:{#regionId}:{#accountId}:disk/{#diskId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DiskId | string | 是 | 云盤 ID。 | d-bp1bq5g3dxxo1x4o**** |
StartTime | string | 是 | 數據的起始時間。按照ISO 8601標準表示,并使用 UTC +0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。如果秒(ss)不是 00,則自動取為下一分鐘開始時。 | 2014-07-23T12:07:00Z |
EndTime | string | 是 | 數據的結束時間。按照ISO 8601標準表示,并使用 UTC +0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。如果秒(ss)不是 00,則自動取為下一分鐘開始時。 | 2014-07-23T12:09:00Z |
Period | integer | 否 | 數據的精度,單位為秒。取值范圍:
默認值:60。 | 60 |
返回參數
示例
正常返回示例
JSON
格式
{
"TotalCount": 3,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"MonitorData": {
"DiskMonitorData": [
{
"BPSRead": 0,
"IOPSRead": 0,
"LatencyRead": 0,
"BPSTotal": 204,
"IOPSTotal": 0,
"TimeStamp": "2014-07-23T12:07:00Z",
"LatencyWrite": 0,
"IOPSWrite": 0,
"DiskId": "d-bp1bq5g3dxxo1x4o****",
"BPSWrite": 204
}
]
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidStartTime.Malformed | The specified parameter "StartTime" is not valid. | - |
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 | InvalidInstanceType.NotSupportCredit | The InstanceType of the specified instance does not support credit. | 實例規格不支持突發性能實例。 |
400 | InvalidParameter.EndTime | The specified parameter EndTime is earlier than StartTime. | 結束時間不能早于開始時間。 |
404 | InvalidDiskId.NotFound | The DiskId provided does not exist in our records. | 指定的磁盤不存在。請您檢查磁盤 ID 是否正確。 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 內部錯誤,請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-12-04 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-05-06 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |