DescribeEipMonitorData - Elastic IP Address - Alibaba Cloud ドキュメントセンター

操作説明

モニタリングデータのクエリにおけるユーザーエクスペリエンスを向上させるため、EIP のモニタリングデータを取得する際は、CloudMonitor が提供する DescribeMetricList API オペレーションの呼び出しを推奨します。詳細については、「DescribeMetricList」および「EIP モニタリングデータ」をご参照ください。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	EIP が属するリージョンの ID です。最新のリージョンリストを取得するには、DescribeRegions オペレーションを呼び出してください。	cn-hangzhou
AllocationId	string	必須	EIP の ID です。	eip-2zeerraiwb7uj6idcfv****
StartTime	string	必須	クエリ対象期間の開始時刻です。時刻は協定世界時 (UTC) で指定する必要があります。ISO 8601 標準に従い、`YYYY-MM-DDThh:mm:ssZ` 形式で指定してください。たとえば、`2013-01-10T12:00:00Z` は、2013 年 1 月 10 日の 20:00:00 (UTC + 08:00) を表します。秒 (ss) の値が 00 でない場合、開始時刻は自動的に次の分に切り上げられます。	2020-01-05T01:05:05Z
EndTime	string	必須	クエリ対象期間の終了時刻です。時刻は協定世界時 (UTC) で指定する必要があります。ISO 8601 標準に従い、`YYYY-MM-DDThh:mm:ssZ` 形式で指定してください。たとえば、`2013-01-10T12:00:00Z` は、2013 年 1 月 10 日の 20:00:00 (UTC + 08:00) を表します。秒 (ss) の値が 00 でない場合、終了時刻は自動的に次の分に切り上げられます。	2020-01-05T03:05:10Z
Period	integer	任意	各モニタリングデータエントリの持続時間です。単位：秒。有効値：60 (デフォルト)、300、900、および 3600。 (EndTime - StartTime)/Period の値が 200 を超える場合、一度に最大 200 件のモニタリングデータエントリが返されます。 (EndTime - StartTime)/Period の値が 200 以下の場合、開始時刻から終了時刻の間に収集されたモニタリングデータのみが返されます。	60

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
RequestId	string	リクエスト ID です。	C8B26B44-0189-443E-9816-D951F59623A9
EipMonitorDatas	object
EipMonitorData	array<object>	EIP のモニタリングデータに関する詳細情報です。
	object
EipTX	integer	アウトバウンドトラフィックです。単位：バイト。	343
EipPackets	integer	パケット数です。	3434
EipBandwidth	integer	平均帯域幅値です。EipFlow/Period に等しくなります。単位：バイト/秒。Period のデフォルト値は 60 です。単位：秒。	10
TimeStamp	string	モニタリングデータのタイムスタンプです。ISO8601 標準に従って指定してください。例：`2020-01-21T09:50:23Z`。	2020-01-21T09:50:23Z
EipFlow	integer	インバウンドトラフィックとアウトバウンドトラフィックの合計です。	465
EipRX	integer	インバウンドトラフィックです。単位：バイト。	122

例

成功レスポンス

JSONJSON

{
  "RequestId": "C8B26B44-0189-443E-9816-D951F59623A9",
  "EipMonitorDatas": {
    "EipMonitorData": [
      {
        "EipTX": 343,
        "EipPackets": 3434,
        "EipBandwidth": 10,
        "TimeStamp": "2020-01-21T09:50:23Z",
        "EipFlow": 465,
        "EipRX": 122
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter.TooMany	monitor parameter too many data required.
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	InvalidAllocationId.NotFound	Specified allocation id is not found.
400	OperationDenied.TooManyDataQueried	Specified operation is denied as too many data to return.
404	InvalidIpInstanceId.NotFound	The specified Eip InstanceId does not exist in our records.
404	InvalidInstanceId.NotFound	The InstanceId provided does not exist in our records.
404	Forbidden.RegionNotFound	Specified region is not found during access authentication.

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

変更履歴

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