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

ECS インスタンスのモニタリングデータをクエリします。クエリできるメトリクスには、ECS インスタンスの vCPU 使用率、バースト可能インスタンスのクレジット、インバウンドデータトラフィック、アウトバウンドデータトラフィック、平均帯域幅が含まれます。

操作説明

操作の説明

この操作の呼び出しでは、以下の項目に注意してください。

一度に返されるデータエントリの最大値は 400 です。(EndTime – StartTime)/Period の値が 400 以下になるようにしてください。つまり、TotalCount レスポンスパラメーターの値は 400 を超えることはできません。超えた場合、InvalidParameter.TooManyDataQueried エラーが返されます。
過去 30 日間の有効なモニタリングデータをクエリできます。StartTime パラメーターの値は、現在の日付から 30 日以上前にはできません。
応答に一部のコンテンツが含まれていない場合、システムが対応する情報を取得できなかった可能性があります。たとえば、その時間にインスタンスが停止 (Stopped) 状態だった場合などです。
この操作では、ECS ベアメタルインスタンスの基本的な CPU モニタリングデータを取得できません。CPU モニタリングデータを取得するには、CloudMonitor エージェントをインストールします。詳細については、「CloudMonitor エージェントのインストール」を参照してください。

今すぐお試しください

この 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:DescribeInstanceMonitorData

get

*Instance。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	クエリするインスタンスのインスタンス ID。	i-bp1a36962lrhj4ab****
StartTime	string	必須	クエリする時間の有効値の開始時刻。時間を ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 初期化で指定します。時間は協定世界時 (UTC) でなければなりません。秒 (ss) の値が 00 でない場合、時間は自動的に次の分に切り上げられます。	2014-10-29T23:00:00Z
EndTime	string	必須	クエリする時間の有効値の終了時刻。時間を ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 初期化で指定します。時間は協定世界時 (UTC) でなければなりません。秒 (ss) の値が 00 でない場合、時間は自動的に次の分に切り上げられます。	2014-10-30T08:00:00Z
Period	integer	任意	モニタリングデータを取得する間隔。単位: 秒。有効な値: 60。 600。 3600。デフォルト値: 60。列挙値: 60 : 60 秒。 600 : 600 秒。 3600 : 3600 秒。	60

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
MonitorData	object
InstanceMonitorData	array<object>	インスタンスモニタリングデータのコレクション。
	object
CPUCreditBalance	number	バースト可能インスタンスのクレジットの合計数。	120
BPSRead	integer	インスタンスディスク (システムディスクおよびデータディスクを含む) の読み取り帯域幅。単位: バイト/秒。	1000
InternetTX	integer	クエリの時間 (TimeStamp) の指定された間隔 (Period) 中にインスタンスによって送信されたパブリックアウトバウンドデータトラフィック。単位: kbits。	343
CPU	integer	インスタンスの vCPU 使用率。単位: パーセント (%)。	2
CPUCreditUsage	number	消費されたバースト可能インスタンスのクレジット数。	30
IOPSWrite	integer	インスタンスディスク (システムディスクおよびデータディスクを含む) への I/O 書き込み操作。単位: 操作/秒。	200
IntranetTX	integer	クエリの時間 (TimeStamp) の指定された間隔 (Period) 中にインスタンスによって送信された内部アウトバウンドデータトラフィック。単位: kbits。	343
InstanceId	string	インスタンス ID	i-bp1a36962lrhj4****
BPSWrite	integer	インスタンスディスク (システムディスクおよびデータディスクを含む) の書き込み帯域幅。単位: バイト/秒。	13585
CPUNotpaidSurplusCreditUsage	number	未払いの超過 CPU クレジット。	0.5
CPUAdvanceCreditBalance	number	超過 CPU クレジット (制限を超えるバースト可能インスタンスのクレジットの部分)。	0.4
IOPSRead	integer	インスタンスディスク (システムディスクおよびデータディスクを含む) からの I/O 読み取り操作。単位: 操作/秒。	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

例

成功レスポンス

JSONJSON

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

エラーコード

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	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 が正しいかどうかを確認してください。

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

変更履歴

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