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

指定された期間におけるセカンダリ Elastic Network Interface (ENI) のモニタリングデータをクエリします。

操作説明

注意事項

セカンダリ ENI のモニタリングデータには、内部ネットワーク経由で送受信されたトラフィック量、セカンダリ ENI が送受信したパケット数、およびセカンダリ ENI によってドロップされた送受信パケット数が含まれます。返されるモニタリングデータには、特定の情報が欠落している場合があります。これは、システムが関連情報を取得できないことが原因である可能性があります。たとえば、セカンダリ ENI がアタッチされているインスタンスが `停止` 状態である場合、またはセカンダリ ENI がインスタンスにアタッチされておらず `利用可能` 状態である場合、セカンダリ ENI のモニタリングデータは取得できません。次の点にご注意ください：

一度に最大 400 件のモニタリングデータエントリを返すことができます。`TotalCount` の値が 400 を超えないようにしてください。値は、数式 TotalCount = (EndTime - StartTime)/Period を使用して計算されます。TotalCount の値が 400 を超える場合、InvalidParameter.TooManyDataQueried エラーが返されます。
過去 30 日間のモニタリングデータをクエリできます。`StartTime` の値が現在時刻より 30 日以上前の場合、エラーが返されます。

今すぐお試しください

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

get

NetworkInterface

acs:ecs:{#regionId}:{#accountId}:eni/{#eniId}

*Instance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
EniId	string	任意	セカンダリ ENI の ID。デフォルトでは、指定されたインスタンスにバインドされているすべてのセカンダリ ENI がクエリされます。	eni-bp19da36d6xdwey****
RegionId	string	必須	リージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
InstanceId	string	必須	セカンダリ ENI がバインドされているインスタンスの ID。	i-bp1a5zr3u7nq9cx****
StartTime	string	必須	クエリする時間範囲の開始時刻。時間は ISO 8601 標準に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時刻は協定世界時 (UTC) である必要があります。秒 (ss) の値が 00 でない場合、時刻は次の分に切り上げられます。	2018-05-21T12:19:00Z
EndTime	string	必須	クエリする時間範囲の終了時刻。時間は ISO 8601 標準に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時刻は協定世界時 (UTC) である必要があります。秒 (ss) の値が 00 でない場合、時刻は次の分に切り上げられます。	2018-05-21T12:22:00Z
Period	integer	任意	モニタリングデータを取得する間隔。単位：秒。有効な値は次のとおりです。 60 600 3600 デフォルト値：60。	60

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	返されたエントリの総数。	4
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
MonitorData	object
EniMonitorData	array<object>	セカンダリ ENI のモニタリングデータ。
	object
PacketRx	string	内部ネットワーク経由でセカンダリ ENI が受信したパケット数。	0
TimeStamp	string	モニタリングデータのタイムスタンプ。時刻は ISO 8601 標準に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で表示されます。時刻は協定世界時 (UTC) で表示されます。	2018-05-21T03:22:00Z
DropPacketRx	string	内部ネットワーク経由でセカンダリ ENI によってドロップされた受信パケット数。	0
EniId	string	セカンダリ ENI の ID。	eni-bp19da36d6xdwey****
DropPacketTx	string	内部ネットワーク経由でセカンダリ ENI によってドロップされた送信パケット数。	0
PacketTx	string	内部ネットワーク経由でセカンダリ ENI が送信したパケット数。	0
IntranetTx	string	セカンダリ ENI が内部ネットワーク経由でデータを送信した平均レート。単位：Kbit/s。	0
IntranetRx	string	セカンダリ ENI が内部ネットワーク経由でデータを受信した平均レート。単位：Kbit/s。	0

例

成功レスポンス

JSONJSON

{
  "TotalCount": 4,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "MonitorData": {
    "EniMonitorData": [
      {
        "PacketRx": "0",
        "TimeStamp": "2018-05-21T03:22:00Z",
        "DropPacketRx": "0",
        "EniId": "eni-bp19da36d6xdwey****",
        "DropPacketTx": "0",
        "PacketTx": "0",
        "IntranetTx": "0",
        "IntranetRx": "0"
      }
    ]
  }
}

エラーレスポンス

JSONJSON

{
 "RequestId":"5A03C2BA-3BCE-4A87-8076-7DC1629",
 "MonitorData":{
     "EniMonitorData":[
         {
             "PacketTx":0,
             "TimeStamp":"2018-05-21T03:22:00Z",
             "IntranetOut":0,
             "DropPacketRx":0,
             "IntranetIn":0,
             "EniId":"eni-myENI",
             "DropPacketTx":0,
             "PacketRx":0
         },
         {
             "PacketTx":0,
             "TimeStamp":"2018-05-21T03:21:00Z",
             "IntranetOut":0,
             "DropPacketRx":0,
             "IntranetIn":0,
             "EniId":"eni-myENI",
             "DropPacketTx":0,
             "PacketRx":0
         },
         {
             "PacketTx":52240,
             "TimeStamp":"2018-05-21T03:19:00Z",
             "IntranetOut":73344,
             "DropPacketRx":0,
             "IntranetIn":467,
             "EniId":"eni-myENI",
             "DropPacketTx":0,
             "PacketRx":6603
         },
         {
             "PacketTx":34925,
             "TimeStamp":"2018-05-21T03:20:00Z",
             "IntranetOut":48871,
             "DropPacketRx":0,
             "IntranetIn":350,
             "EniId":"eni-myENI",
             "DropPacketTx":0,
             "PacketRx":4888
         }
     ]
 }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidEniId.NotFound	The specified ENI ID does not exist.
403	InvalidStartTime.Malformed	The specified parameter "StartTime" is not valid.
403	InvalidEndTime.Malformed	The specified parameter "EndTime" is not valid.
403	InvalidPeriod.ValueNotSupported	The specified parameter "Period" is not valid.
403	InvalidStartTime.TooEarly	The specified parameter "StartTime" is too early.
403	InvalidParameter.TooManyDataQueried	Too many data queried.
403	Throttling	Request was denied due to request throttling.
403	InvalidInstanceType.NotSupportCredit	The InstanceType of the specified instance does not support credit.
403	InvalidParameter.EndTime	The specified parameter EndTime is earlier than StartTime.
4003	InvalidParam.Malformed	The specified parameter "EniId" and "InstanceId" are not valid
404	InvalidDiskId.NotFound	The DiskId provided does not exist in our records.
404	InvalidEcsId.NotFound	The specified instance ID is invalid.

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

変更履歴

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