DescribeRouterInterfaces - API リファレンス| Alibaba Cloud ドキュメントセンター

説明

ルータインターフェイスのリストを照会します。

現在サポートされているフィルタには、RouterInterfaceId、RouterId、RouterType、RouterInterfaceOwnerId、OppositeInterfaceId、OppositeRouterType、OppositeRouterId、OppositeInterfaceOwnerId、Status、および Name が含まれます。

フィルタの値の関係は”または”です。1 つのフィルタが満たされている限り、VBR が返されます。

各フィルタの関係は”と”です。すべてのフィルタが満たされた場合にのみ VBR が返されます。

リクエストパラメータ

名前	型	必須かどうか	説明
Action	String	はい	実行するアクション。有効な値: `DescribeRouterInterfaces`
RegionId	String	はい	ルータインターフェイスが配置されているリージョン。リージョン ID は DescribeRegions API を呼び出すことで取得できます。
Filter.n.Key	String	いいえ	フィルターキー。`n`の有効な値は[1, 5]です。最大 5 つのフィルタがサポートされています。使用可能なフィルタキーは次のとおりです。 `RouterInterfaceId`: ルータインターフェイスの ID。 `RouterId`: VRouter か VBR の ID。 `RouterType`: ルータインタフェースに関連するルータのタイプ。 `RouterInterfaceOwnerId`: ルータインタフェースの所有者 ID。 `OppositeInterfaceId`: ピアルータインターフェイスの ID。 `OppositeRouterType`: ピアルータインタフェースに関連するルータのタイプ。 `OppositeRouterId`: ピアルータの ID です。 `OppositeInterfaceOwnerId`: ピアルータインタフェースの所有者 ID。 `Status`: ルータインタフェースの状態。 `Name`: ルータインタフェースの名前。
Filter.n.Value.m	String	いいえ	指定されたフィルタキーの対応する値。`m`の有効値は[1, 5]です。
PageNumber	Integer	いいえ	返すページ数。デフォルト値は 1 です。
PageSize	Integer	いいえ	1 ページあたりのエントリ数。最大値は 50、デフォルト値は 10 です。

レスポンスパラメータ

名前	型	説明
RequestId	String	リクエストの ID。
TotalCount	Integer	照会された項目の数。
PageNumber	Integer	現在のページ番号。
PageSize	Integer	現在のページのエントリ数。
Instances	JSON string	照会されたルーター・インターフェースの詳細情報。詳細については、 RouterInterfaceSetType を参照してください。

エラーコード

VPC API Error Center を参照してください。

例

リクエストの例

http://vpc.aliyuncs.com/?Action=DescribeRouterInterfaces
&RegionId=cn-beijing
&<CommonParameters>

レスポンスの例

{
  "PageNumber": 1,
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "3F12D2E8-0B95-46F3-BE89-C2D69BF134D0",
  "RouterInterfaceSet": {
    "RouterInterfaceType": [
      {
        "ChargeType": "AfterPay",
        "OppositeInterfaceBusinessStatus": "Normal",
        "RouterInterfaceId": "ri-2ze7fbuohm7pcxxxxx",
        "OppositeInterfaceStatus": "Active",
        "Spec": "Negative",
        "OppositeAccessPointId": "ap-cn-beijing-dx-A",
        "OppositeInterfaceOwnerId": "12315790855xxxxx",
        "OppositeInterfaceSpec": "Large.1",
        "CreationTime": "2018-03-01T07:19:31Z",
        "RouterType": "VRouter",
        "Status": "Active",
        "OppositeRouterType": "VBR",
        "OppositeRouterId": "vbr-2zee2e2cwetx4xxxxxx",
        "OppositeInterfaceId": "ri-2ze07ad6sgzixxxxx",
        "VpcInstanceId": "vpc-2zefsil0x93dguxxxxx",
        "RouterId": "vrt-2zepuy8qbrq6xxxxx",
        "ConnectedTime": "2018-03-01T07:19:32Z",
        "OppositeRegionId": "cn-beijing",
        "BusinessStatus": "Normal",
        "Role": "AcceptingSide",
        "EndTime": "2999-09-08T16:00:00Z"
      }
    ]
  }
}