DescribeDiskMonitorData - Elastic Compute Service

查詢一塊雲端硬碟在指定時間內的使用資訊，例如，雲端硬碟讀IOPS、寫IOPS、讀頻寬（B/s）、寫頻寬（B/s）、讀時延（μs）以及寫時延（μs）。

介面說明

呼叫該介面時，您需要注意以下限制：

只能查詢狀態為使用中（In_use）的雲端硬碟使用資訊。更多詳情，請參見普通雲端硬碟狀態表。

說明
若查詢的資訊中出現內容缺失，是因為無法取得該段時間的使用資訊，即雲端硬碟狀態不是使用中（In_use）。
一次最多返回 400 條資料，需滿足（EndTime–StartTime）/Period小於等於 400 的條件限制，即返回參數TotalCount不能超過 400，否則將返回InvalidParameter.TooManyDataQueried的錯誤提示。
一次最多能查詢近 30 天內的監控資訊，即指定的參數StartTime距今不能超過 30 天。

請求示例

假設您需要查詢華東 1（杭州）地域下 ID 為d-bp14emm68wx98vjk****的磁碟，在2025-02-17T00:00:00Z至2025-02-18T10:00:00Z期間，每 600 秒內的使用資訊。相關配置請求參數如下：

RegionId:"cn-hangzhou", //設定華東 1（杭州）地域
DiskId:"d-bp14emm68wx98vjk****", //設定磁碟 ID
StartTime:"2025-02-15T00:00:00Z", //設定查詢起始時間
EndTime:"2025-02-17T00:00:00Z", //設定查詢結束時間
Period:"600", //設定資料精度
```。

調試

您可以在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，則自動取為下一分鐘開始時。說明一次最多能查詢近 30 天內的監控資訊，即參數`StartTime`距今不能超過 30 天。	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。 600。 3600。預設值：60。說明（EndTime–StartTime）/Period 必須小於等於 400，即一次最多返回 400 個週期的資料。	60

返回參數

名稱	類型	描述	樣本值
	object
TotalCount	integer	雲端硬碟使用資訊的返回條目數量，即週期數。	3
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
MonitorData	object
DiskMonitorData	array<object>	雲端硬碟的監控資料集合。
	object	雲端硬碟的監控資料集合。
BPSRead	integer	雲端硬碟讀頻寬，單位：Byte/s。	0
IOPSRead	integer	雲端硬碟 I/O 讀操作，單位：次/s。	0
LatencyRead	integer	雲端硬碟讀時延。單位：μs（微秒）。	0
BPSTotal	integer	雲端硬碟讀寫總頻寬，單位：Byte/s。	204
IOPSTotal	integer	雲端硬碟 I/O 讀寫總操作，單位：次/s。	0
TimeStamp	string	查詢監控資訊的時間戳記。按照ISO 8601標準表示，並使用 UTC +0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。	2014-07-23T12:07:00Z
LatencyWrite	integer	雲端硬碟寫時延。單位：μs（微秒）。	0
IOPSWrite	integer	雲端硬碟 I/O 寫操作，單位：次/s。	0
DiskId	string	雲端硬碟 ID。	d-bp1bq5g3dxxo1x4o****
BPSWrite	integer	雲端硬碟寫頻寬，單位：Byte/s。	204

樣本

正常返回樣本

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
      }
    ]
  }
}

異常返回樣本

JSON格式

{
  "MonitorData": {
    "DiskMonitorData": [
      {
        "BPSRead": 0,
        "BPSTotal": 0,
        "BPSWrite": 0,
        "DiskId": "d-23b3p4r8b",
        "IOPSRead": 0,
        "IOPSTotal": 0,
        "IOPSWrite": 0,
        "TimeStamp": "2014-07-23T12:07:00Z"
      },
      {
        "BPSRead": 0,
        "BPSTotal": 204,
        "BPSWrite": 204,
        "DiskId": "d-23b3p4r8b",
        "IOPSRead": 0,
        "IOPSTotal": 0,
        "IOPSWrite": 0,
        "TimeStamp": "2014-07-23T12:08:00Z"
      },
      {
        "BPSRead": 0,
        "BPSTotal": 819,
        "BPSWrite": 819,
        "DiskId": "d-23b3p4r8b",
        "IOPSRead": 0,
        "IOPSTotal": 0,
        "IOPSWrite": 0,
        "TimeStamp": "2014-07-23T12:09:00Z"
      }
    ]
  }, 
  "RequestId": "A48A0A77-34F5-4C33-9066-9E8D2DA0D8E2",
  "TotalCount": 3
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidStartTime.Malformed	The specified parameter "StartTime" is not valid.
400	InvalidEndTime.Malformed	The specified parameter "EndTime" is not valid.
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.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
404	InvalidDiskId.NotFound	The DiskId provided does not exist in our records.

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

變更歷史

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