edit-icon download-icon

DescribeRouterInterfaces

最終更新日: May 28, 2018

説明

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

現在サポートされているフィルタには、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 を参照してください。

リクエストの例

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

レスポンスの例

  1. {
  2. "PageNumber": 1,
  3. "TotalCount": 1,
  4. "PageSize": 10,
  5. "RequestId": "3F12D2E8-0B95-46F3-BE89-C2D69BF134D0",
  6. "RouterInterfaceSet": {
  7. "RouterInterfaceType": [
  8. {
  9. "ChargeType": "AfterPay",
  10. "OppositeInterfaceBusinessStatus": "Normal",
  11. "RouterInterfaceId": "ri-2ze7fbuohm7pcxxxxx",
  12. "OppositeInterfaceStatus": "Active",
  13. "Spec": "Negative",
  14. "OppositeAccessPointId": "ap-cn-beijing-dx-A",
  15. "OppositeInterfaceOwnerId": "12315790855xxxxx",
  16. "OppositeInterfaceSpec": "Large.1",
  17. "CreationTime": "2018-03-01T07:19:31Z",
  18. "RouterType": "VRouter",
  19. "Status": "Active",
  20. "OppositeRouterType": "VBR",
  21. "OppositeRouterId": "vbr-2zee2e2cwetx4xxxxxx",
  22. "OppositeInterfaceId": "ri-2ze07ad6sgzixxxxx",
  23. "VpcInstanceId": "vpc-2zefsil0x93dguxxxxx",
  24. "RouterId": "vrt-2zepuy8qbrq6xxxxx",
  25. "ConnectedTime": "2018-03-01T07:19:32Z",
  26. "OppositeRegionId": "cn-beijing",
  27. "BusinessStatus": "Normal",
  28. "Role": "AcceptingSide",
  29. "EndTime": "2999-09-08T16:00:00Z"
  30. }
  31. ]
  32. }
  33. }