DescribeDiskMonitorData - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

指定された期間内のディスクの使用量情報（読み取り IOPS、書き込み IOPS、読み取り帯域幅 (B/s)、書き込み帯域幅 (B/s)、読み取りレイテンシ (μs)、書き込みレイテンシ (μs) など）を照会します。

操作説明

この操作を呼び出す際は、以下の使用制限にご注意ください。

使用中 (In_use) 状態のディスクの使用量情報のみをクエリできます。詳細については、「ディスクの状態」をご参照ください。

説明
返された情報に欠落がある場合、その期間中にディスクが使用中 (In_use) 状態ではなかったため、使用量情報を取得できません。
一度に最大 400 件のデータエントリを返すことができます。(EndTime – StartTime) / Period の値は 400 以下である必要があります。つまり、レスポンスパラメーター TotalCount の値は 400 を超えることができません。超えた場合、InvalidParameter.TooManyDataQueried エラーが返されます。
過去 30 日間のモニタリング情報をクエリできます。指定する StartTime パラメーターは、現在の時間から 30 日以上前にすることはできません。

リクエスト例

シンガポールリージョンで ID が d-bp14emm68wx98vjk**** のディスクの使用量情報を、2025-02-17T00:00:00Z から 2025-02-18T10:00:00Z まで 600 秒間隔でクエリする場合、リクエストパラメーターを以下のように設定します。

RegionId:"ap-southeast-1", // シンガポールリージョンをセット
DiskId:"d-bp14emm68wx98vjk****", // ディスク ID をセット
StartTime:"2025-02-15T00:00:00Z", // クエリの開始時刻をセット
EndTime:"2025-02-17T00:00:00Z", // クエリの終了時刻をセット
Period:"600", // データ粒度をセット
```.

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeDiskMonitorData

get

*Disk

acs:ecs:{#regionId}:{#accountId}:disk/{#diskId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DiskId	string	必須	クエリするディスクの ID。	d-bp1bq5g3dxxo1x4o****
StartTime	string	必須	データの開始時刻。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で指定します。時間は協定世界時 (UTC) である必要があります。秒 (ss) の値が 00 でない場合、開始時刻は自動的に次の分の先頭にセットされます。説明過去 30 日間のモニタリング情報をクエリできます。`StartTime` パラメーターは、現在の時間から 30 日以上前にすることはできません。	2014-07-23T12:07:00Z
EndTime	string	必須	データの終了時刻。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で指定します。時間は協定世界時 (UTC) である必要があります。秒 (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	ディスクの 1 秒あたりの読み取り I/O 操作の数。	0
LatencyRead	integer	ディスクの読み取りレイテンシ。単位：マイクロ秒。	0
BPSTotal	integer	ディスクの合計読み取り/書き込み帯域幅。単位：byte/s。	204
IOPSTotal	integer	ディスクの 1 秒あたりの合計読み取り/書き込み I/O 操作の数。	0
TimeStamp	string	モニタリングデータのタイムスタンプ。時間は ISO 8601 標準に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で表示されます。時間は協定世界時 (UTC) です。	2014-07-23T12:07:00Z
LatencyWrite	integer	ディスクの書き込みレイテンシ。単位：マイクロ秒。	0
IOPSWrite	integer	ディスクの 1 秒あたりの書き込み I/O 操作の数。	0
DiskId	string	ディスクの ID。	d-bp1bq5g3dxxo1x4o****
BPSWrite	integer	ディスクの書き込み帯域幅。単位：byte/s。	204

例

成功レスポンス

JSONJSON

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

エラーレスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ
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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。