DescribeUserBandWidthData を使用したユーザー帯域幅データの查询 - ENS

指定された期間内に使用した帯域幅を照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeUserBandWidthData

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
EnsRegionId	string	任意	ノードの ID。指定できるノード ID は 1 つだけです。デフォルトでは、すべてのノードが照会されます。	cn-taiyuan-telecom
InstanceId	string	任意	データを照会するインスタンスの ID。指定できるインスタンス ID は 1 つだけです。デフォルトでは、すべてのインスタンスが照会されます。	i-5inkeimcipxk26yqtzm4q****
StartTime	string	必須	照会する時間範囲の開始時刻。時間は ISO 8601 形式 (yyyy-MM-ddTHH:mm:ssZ) で指定する必要があります。時刻は協定世界時 (UTC) である必要があります。秒の値が 00 でない場合、開始時刻は自動的に次の分に設定されます。	2019-05-21T10:22:00Z
EndTime	string	必須	照会する時間範囲の終了時刻。時間は ISO 8601 形式 (yyyy-MM-ddTHH:mm:ssZ) で指定する必要があります。時刻は協定世界時 (UTC) である必要があります。秒の値が 00 でない場合、開始時刻は自動的に次の分に設定されます。	2019-05-21T12:22:00Z
Period	string	必須	取得するモニタリングデータの精度。有効値：300、1200、3600、14400。デフォルト値：300。単位：秒。	300
Isp	string	任意	ISP (インターネットサービスプロバイダー)。有効値： cmcc：China Mobile telecom：China Telecom unicom：China Unicom multiCarrier：マルチライン ISP	cmcc

レスポンスフィールド

フィールド	型	説明	例
	object
Code	integer	返されるサービスコード。0 はリクエストが成功したことを示します。	0
MonitorData	object	モニタリングデータ。
BandWidthMonitorData	array<object>	帯域幅データ。
	object
DownBandWidth	integer	アウトバウンド帯域幅。単位：bit/s。	0
InternetRX	integer	インスタンスへのインターネットトラフィック。単位：バイト。	0
InternetTX	integer	インスタンスからのインターネットトラフィック。単位：バイト。	0
TimeStamp	string	モニタリングデータが照会されたときのタイムスタンプ。時刻は ISO 8601 形式 (yyyy-MM-ddTHH:mm:ssZ) に従います。時刻は協定世界時 (UTC) で表示されます。	2019-10-12T05:45:00Z
UpBandWidth	integer	インバウンド帯域幅。単位：bit/s。	0
MaxDownBandWidth	string	照会された時間範囲内の最大アウトバウンド帯域幅。単位：bit/s。	16817468
MaxUpBandWidth	string	照会された時間範囲内の最大インバウンド帯域幅。単位：bit/s。	231008
RequestId	string	リクエスト ID。	50373E71-7710-4620-8AAB-133CCE49451C

例

成功レスポンス

JSONJSON

{
  "Code": 0,
  "MonitorData": {
    "BandWidthMonitorData": [
      {
        "DownBandWidth": 0,
        "InternetRX": 0,
        "InternetTX": 0,
        "TimeStamp": "2019-10-12T05:45:00Z",
        "UpBandWidth": 0
      }
    ],
    "MaxDownBandWidth": "16817468",
    "MaxUpBandWidth": "231008"
  },
  "RequestId": "50373E71-7710-4620-8AAB-133CCE49451C"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParameter	The input parameters that is mandatory for processing this request is not supplied.
400	USERNOTFOUND	The user is not in ens-controller.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

変更履歴

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