ENS インスタンス帯域幅詳細 API の概要 - ENS

インスタンスの帯域幅の詳細を 5 分の粒度でクエリします。

操作説明

リクエストパラメーターはフィルターとして機能し、論理 AND を使用して結合されます。パラメーターが空の場合、フィルター処理には使用されません。ただし、InstanceIds パラメーターに空の JSON 配列を指定した場合、フィルターが適用され、空の結果が返されます。

今すぐお試しください

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

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
StartTime	string	必須	開始時刻。yyyy-MM-dd HH:mm:ss 形式で時刻を指定します。	2024-01-11 00:00:00
EndTime	string	必須	終了時刻。クエリできる最大時間範囲は 24 時間 (86,400 秒) です。クエリでは左閉右開区間が使用されます。yyyy-MM-dd HH:mm:ss 形式で時刻を指定します。	2024-01-11 30:00:00
ServiceType	string	任意	サービスタイプ。例：vm、eip、esk、meta。	vm
InstanceType	string	任意	インスタンスタイプ。このパラメーターを空のままにすると、すべてのタイプがクエリされます。例：vm、eip、single_tenant、nc。	vm
EnsRegionId	string	任意	ENS エッジノードの ID。	cn-beijing-cmcc
InstanceId	string	任意	インスタンス ID。	i-6ecpqvkicnchxccozrpxxxx
PageNumber	integer	任意	ページ番号。デフォルト値は 1 です。	1
PageSize	integer	任意	ページあたりのエントリ数。デフォルト値は 200 です。	10

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマ。
RequestId	string	リクエスト ID。	C0003E8B-B930-4F59-ADC0-0E209A9012A8
Bandwidths	array<object>	パブリック帯域幅情報のコレクション。
	object	パブリック帯域幅情報のコレクション。
InstanceId	string	インスタンス ID。	i-6ecpqvkicnchxccozrpxxxx
ServiceType	string	サービスタイプ。例：vm、eip、esk、meta。	vm
InstanceType	string	インスタンスタイプ。例：vm、eip、single_tenant、nc。	vm
AliUid	integer	ユーザー ID。	1972653484384661
EnsRegionId	string	エッジノードの ID。	cn-yichang-2
TxBw	integer	アウトバウンド帯域幅。単位：bit/s。	25415638
RxBw	integer	インバウンド帯域幅。単位：bit/s。	43795230
Ip	string	インスタンスの IP アドレス。	203.107.***
Isp	string	IP アドレスのインターネットサービスプロバイダー (ISP)。	cmcc
FlowType	integer	帯域幅タイプ。有効値：1 (パブリックネットワーク) および 2 (内部ネットワーク)。	1
BizTime	string	データポイントのタイムスタンプ。データは 5 分間隔で収集されます。	2024-01-11 00:00:00
PageNumber	integer	現在のページ番号。	1
PageSize	integer	ページあたりのエントリ数。	10
TotalCount	integer	エントリの総数。	1

例

成功レスポンス

JSONJSON

{
  "RequestId": "C0003E8B-B930-4F59-ADC0-0E209A9012A8",
  "Bandwidths": [
    {
      "InstanceId": "i-6ecpqvkicnchxccozrpxxxx",
      "ServiceType": "vm",
      "InstanceType": "vm",
      "AliUid": 1972653484384661,
      "EnsRegionId": "cn-yichang-2",
      "TxBw": 25415638,
      "RxBw": 43795230,
      "Ip": "203.107.***",
      "Isp": "cmcc",
      "FlowType": 1,
      "BizTime": "2024-01-11 00:00:00"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ParamNotEnough	参数不足
400	ParamScopeError	参数值错误
400	ParamTypeError	参数类型错误
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

変更履歴

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