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

説明

この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに Vpc(2016-04-28) - DescribeRouterInterfaces への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vpc:DescribeRouterInterfaces

get

*RouterInterface

acs:vpc:{#regionId}:{#accountId}:routerinterface/{#RouterInterfaceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。`DescribeRegions` API を呼び出して、最新のリージョンリストを取得できます。
PageNumber	integer	任意	ページ番号。ページ番号は 1 から始まります。デフォルト値： 1。
PageSize	integer	任意	1 ページあたりのエントリ数。有効な値： 1～100。デフォルト値： 10。
Filter	array<object>	任意	フィルター。
	object	任意
Key	string	任意	フィルターキー。指定可能な値： `RouterInterfaceId`：ルーターインターフェイスの ID。 `RouterId`：ルーターインターフェイスのアタッチ先ルーターの ID。 `RouterType`：ルーターのタイプ。有効な値： `VRouter` および `VBR`。 `Status`：ルーターインターフェイスのステータス。 `Name`：ルーターインターフェイスの名前。 `Role`：ルーターインターフェイスのロール。有効な値：開始側 (`InitiatingSide`) および承諾側 (`AcceptingSide`)。
Value	array	任意	フィルターキーに対応する値。最大 20 個の値を指定できます。
	string	任意

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディ。
RequestId	string	リクエスト ID。
PageNumber	integer	ページ番号。
PageSize	integer	ページあたりのエントリー数。
TotalCount	integer	合計エントリー数。
RouterInterfaceSet	object	ルーターインターフェイスの詳細。
RouterInterfaceType	array<object>	ルーターインターフェイスの配列。
	object
HealthCheckTargetIp	string	ヘルスチェックのターゲット IP アドレス。
CreationTime	string	ルーターインターフェイスが作成された時刻。時刻は UTC で、 `YYYY-MM-DDThh:mm:ssZ` 形式です。
Status	string	ルーターインターフェイスのステータス。有効な値： `Idle` `Activating` `Active` `Deactivating` `Inactive` `Deleting`
Spec	string	ルーターインターフェイスの仕様。
OppositeInterfaceId	string	対向ルーターインターフェイスの ID。
RouterInterfaceId	string	ルーターインターフェイスの ID。
ChargeType	string	ルーターインターフェイスの課金方法。有効な値： PostPaid ：従量課金 PrePaid ：サブスクリプション
OppositeRouterType	string	対向ルーターのタイプ。有効な値： `VRouter` `VBR`
OppositeInterfaceOwnerId	string	対向ルーターインターフェイスの所有者アカウントの ID。
Description	string	ルーターインターフェイスの説明。
Name	string	ルーターインターフェイスの名前。
OppositeRouterId	string	対向ルーターの ID。
OppositeInterfaceSpec	string	対向ルーターインターフェイスの仕様。
RouterId	string	ルーターインターフェイスが属するルーターの ID。
OppositeInterfaceBusinessStatus	string	対向ルーターインターフェイスのビジネスステータス。有効な値： `Normal` `FinancialLocked` `SecurityLocked`
ConnectedTime	string	接続が確立された時刻。時刻は UTC で、 `YYYY-MM-DDThh:mm:ssZ` 形式です。
OppositeInterfaceStatus	string	対向ルーターインターフェイスのステータス。
HealthCheckSourceIp	string	ヘルスチェックのソース IP アドレス。
EndTime	string	サブスクリプション課金のルーターインターフェイスの有効期限。このパラメーターは、 `ChargeType` が `PrePaid` に設定されている場合にのみ返されます。時刻は UTC で、 `YYYY-MM-DDThh:mm:ssZ` 形式です。
OppositeRegionId	string	対向ルーターインターフェイスのリージョン ID。
OppositeAccessPointId	string	対向アクセスポイントの ID。
BusinessStatus	string	ルーターインターフェイスのビジネスステータス。有効な値： `Normal` `FinancialLocked` `SecurityLocked`
Role	string	接続におけるルーターインターフェイスのロール。有効な値： `InitiatingSide` ：開始側 `AcceptingSide` ：受け入れ側
RouterType	string	ルーターインターフェイスが属するルーターのタイプ。有効な値： `VRouter` `VBR`
AccessPointId	string	アクセスポイントの ID。

例

成功レスポンス

JSONJSON

{
  "RequestId": "",
  "PageNumber": 0,
  "PageSize": 0,
  "TotalCount": 0,
  "RouterInterfaceSet": {
    "RouterInterfaceType": [
      {
        "HealthCheckTargetIp": "",
        "CreationTime": "",
        "Status": "",
        "Spec": "",
        "OppositeInterfaceId": "",
        "RouterInterfaceId": "",
        "ChargeType": "",
        "OppositeRouterType": "",
        "OppositeInterfaceOwnerId": "",
        "Description": "",
        "Name": "",
        "OppositeRouterId": "",
        "OppositeInterfaceSpec": "",
        "RouterId": "",
        "OppositeInterfaceBusinessStatus": "",
        "ConnectedTime": "",
        "OppositeInterfaceStatus": "",
        "HealthCheckSourceIp": "",
        "EndTime": "",
        "OppositeRegionId": "",
        "OppositeAccessPointId": "",
        "BusinessStatus": "",
        "Role": "",
        "RouterType": "",
        "AccessPointId": ""
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParam.NotNull	The parameter must not be null.
400	IllegalParam.AliUid	Specified value of aliuid invalid.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key
404	InvalidOppositeRegionId.NotFound	The oppositeRegionId provided does not exist in our records.

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

変更履歴

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