DescribeEpnInstances を使用して EPN インスタンスをクエリ - ENS

EPN インスタンスを照会します。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
EPNInstanceId	string	任意	バージョン番号。	2017-11-10
EPNInstanceName	string	任意	EPN インスタンスの名前。	testEPNInstanceName
PageNumber	integer	任意	ページ番号。デフォルト値: 1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。有効な値: 1～50。デフォルト値: 10。	10

レスポンスフィールド

フィールド	型	説明	例
	object
EPNInstances	object
EPNInstance	array<object>	EPN インスタンスの詳細。
	object
CreationTime	string	インスタンスが作成された時刻。時刻は協定世界時 (UTC) で表示されます。	2019-11-01T06:08:46Z
EPNInstanceId	string	EPN インスタンスの ID。	epn****
EPNInstanceName	string	EPN インスタンスの名前。	ens_test_epn
EPNInstanceType	string	値を EdgeToEdge に設定します。	EdgeToEdge
EndTime	string	データが照会された時間範囲の終了時刻。時刻は協定世界時 (UTC) で表示されます。	2019-11-01T06:08:46Z
InternetMaxBandwidthOut	integer	インバウンド帯域幅。単位: Mbit/s。	40
ModifyTime	string	インスタンスが最後に変更された時刻。時刻は協定世界時 (UTC) で表示されます。	2019-11-01T06:08:46Z
NetworkingModel	string	ネットワークモード。有効な値: SpeedUp: インテリジェントアクセラレーションネットワーク (インターネット) Connection: 内部ネットワーク SpeedUpAndConnection: インテリジェントアクセラレーションネットワークと内部ネットワーク	SpeedUp
StartTime	string	データが照会された時間範囲の開始時刻。時刻は協定世界時 (UTC) で表示されます。	2019-11-01T06:08:46Z
Status	string	インスタンスのステータス。有効な値: Running Excuting Stopped	Running
PageNumber	integer	ページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	40
RequestId	string	リクエスト ID。	A1707FC0-430C-423A-B624-284046B20399
TotalCount	integer	返されたページの総数。	1

例

成功レスポンス

JSONJSON

{
  "EPNInstances": {
    "EPNInstance": [
      {
        "CreationTime": "2019-11-01T06:08:46Z",
        "EPNInstanceId": "epn****",
        "EPNInstanceName": "ens_test_epn",
        "EPNInstanceType": "EdgeToEdge",
        "EndTime": "2019-11-01T06:08:46Z",
        "InternetMaxBandwidthOut": 40,
        "ModifyTime": "2019-11-01T06:08:46Z",
        "NetworkingModel": "SpeedUp",
        "StartTime": "2019-11-01T06:08:46Z",
        "Status": "Running"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 40,
  "RequestId": "A1707FC0-430C-423A-B624-284046B20399",
  "TotalCount": 1
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParameter	The input parameter that is mandatory for processing this request is not supplied.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
400	InvalidParameter	The errorMessage is %s. Please check it again.
400	ens.interface.error	An error occurred while calling the API.
400	CallInterface	Call Interface Happen Error.

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

変更履歴

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