すべてのプロダクト
Search

このプロダクト

    Virtual Private Cloud:DescribeRouterInterfaces

    ドキュメントセンター

    Virtual Private Cloud:DescribeRouterInterfaces

    最終更新日:Apr 27, 2026

    指定されたリージョン内のルーターインターフェイスをクエリします。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    ルーターインターフェイスのリージョン ID です。

    最新のリージョンリストを取得するには、DescribeRegions 操作を呼び出してください。

    cn-hangzhou
    IncludeReservationData

    boolean

    任意

    更新データを含めるかどうかを指定します。有効値は以下のとおりです。

    • true

    • false (デフォルト)

    false
    PageNumber

    integer

    任意

    ページ番号です。デフォルト値は 1 です。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数です。最大値は 50、デフォルト値は 10 です。

    10
    Filter

    array<object>

    任意

    フィルター情報です。

    object

    任意

    Key

    string

    任意

    フィルター条件です。最大 5 つのフィルター条件を指定できます。サポートされるフィルター条件は以下のとおりです。

    • RouterInterfaceId：ルーターインターフェイスの ID。

    • RouterId：ルーターの ID。

    • RouterType：ルーターの種類。有効値：VRouter、VBR。

    • RouterInterfaceOwnerId：ルーターインターフェイスが属する Alibaba Cloud アカウントの ID。

    • OppositeInterfaceId：ピアルーターインターフェイスの ID。

    • OppositeRouterType：ピアルーターインターフェイスの種類。有効値：VRouter、VBR。

    • OppositeRouterId：ピアルーターの ID。

    • OppositeInterfaceOwnerId：ピアルーターインターフェイスが属する Alibaba Cloud アカウントの ID。

    • Status：ルーターインターフェイスのステータス。

    • Name：ルーターインターフェイスの名前。

    説明

    1 つのフィルター条件内で複数の値を指定した場合、それらの間の論理演算子は OR です。いずれかの値に一致すれば、そのフィルター条件は満たされます。一方、複数のフィルター条件間の論理演算子は AND です。すべてのフィルター条件を満たすルーターのみがクエリされます。

    Filter.1.Status
    Value

    array

    任意

    キーに基づいてフィルター条件の値を指定します。1 つのキーに対して複数のフィルター値を指定できます。フィルター値間の論理演算子は OR です。いずれかのフィルター値に一致すれば、そのフィルター条件は満たされます。

    Filter.1.Active 1

    string

    任意

    キーに基づいてフィルター条件の値を指定します。1 つのキーに対して複数のフィルター値を指定できます。フィルター値間の論理演算子は OR です。いずれかのフィルター値に一致すれば、そのフィルター条件は満たされます。

    test
    ResourceGroupId

    string

    任意

    リソースグループ ID です。

    リソースグループの詳細については、「リソースグループとは」をご参照ください。

    rg-acfmxazb4ph6aiy****
    Tags

    array<object>

    任意

    リソースのタグです。

    object

    任意

    Key

    string

    任意

    リソースタグのキーです。少なくとも 1 つのタグキーを入力する必要があります。最大で 20 個のタグキーをサポートします。この値を渡す必要がある場合は、空文字列にすることはできません。

    タグキーは最大 128 文字までサポートされ、「aliyun」または「acs:」で始まることはできず、「http://」または「https://」を含んではいけません。

    FinanceDept
    Value

    string

    任意

    リソースタグの値です。最大で 20 個のタグ値を入力できます。この値を渡す必要がある場合は、空文字列を入力できます。

    最大 128 文字までサポートされ、「aliyun」または「acs:」で始まることはできず、「http://」または「https://」を含んではいけません。

    FinanceJoshua

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID です。

    C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45
    PageNumber

    integer

    ページ番号です。デフォルト値は 1 です。

    1
    PageSize

    integer

    1 ページあたりのエントリ数です。最大値は 50、デフォルト値は 10 です。

    10
    TotalCount

    integer

    返されたエントリの数です。

    1
    RouterInterfaceSet

    object

    RouterInterfaceType

    array<object>

    ルーターインターフェイスの詳細です。

    array<object>

    ReservationActiveTime

    string

    更新が有効になる時刻です。

    時刻は ISO8601 標準に従い、YYYY-MM-DDThh:mmZ 形式で表示されます。時刻は協定世界時 (UTC) で表示されます。

    2021-03-11T16:00:00Z
    HealthCheckTargetIp

    string

    ヘルスチェックに使用される宛先 IP アドレスです。

    116.62.XX.XX
    Status

    string

    ルーターインターフェイスのステータスです。

    active
    CreationTime

    string

    ルートテーブルが作成された時刻です。

    時刻は ISO8601 標準に従い、YYYY-MM-DDThh:mmZ 形式で表示されます。時刻は協定世界時 (UTC) で表示されます。

    2021-06-08T12:20:55
    ReservationOrderType

    string

    更新注文のタイプです。有効値は以下のとおりです。

    RENEWCHANGE
    OppositeInterfaceId

    string

    ピアルーターインターフェイスの ID です。

    ri-bp1itx13bwe6f2wfh****
    Spec

    string

    ルーターインターフェイスの仕様です。

    Large
    ChargeType

    string

    課金方法です。

    PayByTraffic
    RouterInterfaceId

    string

    ルーターインターフェイスの ID です。

    ri-2zenfgfpyu3v93koa****
    HcThreshold

    integer

    ヘルスチェックのしきい値です。

    2
    OppositeRouterType

    string

    ピアルーターインターフェイスが属するルーターの種類です。

    VRouter
    VpcInstanceId

    string

    ピアリング接続におけるローカル VPC の ID です。

    vpc-2ze3tq4uxhysg717x****
    OppositeInterfaceOwnerId

    string

    ピアルーターインターフェイスが属する Alibaba Cloud アカウントの ID です。

    271598332402530847
    OppositeVpcInstanceId

    string

    ピア VPC の ID です。

    vpc-bp1qpo0kug3a20qqe****
    ReservationInternetChargeType

    string

    更新が有効になった後の課金方法です。有効値は以下のとおりです。

    PayByBandwidth
    CrossBorder

    boolean

    接続がクロスボーダー接続であるかどうかを示します。

    false
    Bandwidth

    integer

    ルーターインターフェイスの帯域幅です。単位：Mbit/s。

    10
    Description

    string

    ルーターインターフェイスの説明です。

    路由表接口描述
    HcRate

    integer

    ヘルスチェックのレートです。

    1
    ReservationBandwidth

    string

    更新が有効になった後の最大帯域幅です。単位：Mbit/s。

    10
    Name

    string

    カスタム名です。

    test
    OppositeRouterId

    string

    ピアルーターインターフェイスが属するルーターの ID です。

    vrt-bp1d3bxtdv68tfd7g****
    OppositeInterfaceSpec

    string

    ピアルーターインターフェイスの仕様です。

    Large
    RouterId

    string

    ルートエントリが属するルーターの ID です。

    vrt-bp1d3bxtdv68tfd7g****
    OppositeInterfaceBusinessStatus

    string

    ピアルーターインターフェイスのサービスステータスです。

    Normal
    ConnectedTime

    string

    接続が確立された時刻です。

    時刻は ISO8601 標準に従い、YYYY-MM-DDThh:mmZ 形式で表示されます。時刻は協定世界時 (UTC) で表示されます。

    2021-06-08T12:20:55
    HealthCheckSourceIp

    string

    ヘルスチェックに使用される送信元 IP アドレスです。

    116.62.XX.XX
    OppositeInterfaceStatus

    string

    ピアルーターインターフェイスのステータスです。

    Normal
    EndTime

    string

    データがクエリされた期間の終了時刻です。

    時刻は ISO8601 標準に従い、YYYY-MM-DDThh:mmZ 形式で表示されます。時刻は協定世界時 (UTC) で表示されます。

    2021-06-08T12:20:55
    OppositeRegionId

    string

    ピアルーターインターフェイスのリージョン ID です。

    cn-shanghai
    OppositeAccessPointId

    string

    ピアアクセスポイントの ID です。

    ap-cn-shanghaiSZ-****
    BusinessStatus

    string

    ルーターインターフェイスのサービスステータスです。有効値は以下のとおりです。

    • Normal

    • FinancialLocked

    • SecurityLocked

    Normal
    OppositeBandwidth

    integer

    ピアルーターインターフェイスの最大帯域幅です。単位：Mbit/s。

    12
    RouterType

    string

    ルートテーブルが属するルーターの種類です。有効値は以下のとおりです。

    • VRouter

    • VBR

    VRouter
    Role

    string

    ルーターインターフェイスがピアリング接続の開始側か受信側かを示します。

    InitiatingSide
    HasReservationData

    string

    更新データが含まれているかどうかを示します。

    false
    AccessPointId

    string

    アクセスポイントの ID です。

    ap-cn-shanghaiSZ-****
    Ipv6Status

    string

    悪意のある IPv6 トラフィックに対する保護が有効かどうかを示します。有効値は以下のとおりです。

    • on

    • off

    • unsupport

    on
    FastLinkMode

    boolean

    VBR が Fast Link モードで作成され、ルーターインターフェイスにアップリンクされているかどうかを示します。Fast Link モードを使用すると、VBR とそのピア VPC 用に作成されたルーターインターフェイスを自動的に接続できます。有効値は以下のとおりです。

    • true

    • false (デフォルト)

    false
    ResourceGroupId

    string

    リソースグループ ID です。

    リソースグループの詳細については、「リソースグループとは」をご参照ください。

    rg-acfmxazb4ph6aiy****
    Tags

    object

    Tags

    array<object>

    リソースのタグです。

    object

    Key

    string

    リソースタグのキーです。少なくとも 1 つのタグキーを入力する必要があります。最大で 20 個のタグキーをサポートします。この値を渡す必要がある場合は、空文字列にすることはできません。

    タグキーは最大 128 文字までサポートされ、「aliyun」または「acs:」で始まることはできず、「http://」または「https://」を含んではいけません。

    FinanceDept
    Value

    string

    リソースタグの値です。最大で 20 個のタグ値を入力できます。この値を渡す必要がある場合は、空文字列を入力できます。

    最大 128 文字までサポートされ、「aliyun」または「acs:」で始まることはできず、「http://」または「https://」を含んではいけません。

    FinanceJoshua

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "RouterInterfaceSet": {
    "RouterInterfaceType": [
      {
        "ReservationActiveTime": "2021-03-11T16:00:00Z",
        "HealthCheckTargetIp": "116.62.XX.XX",
        "Status": "active",
        "CreationTime": "2021-06-08T12:20:55",
        "ReservationOrderType": "RENEWCHANGE",
        "OppositeInterfaceId": "ri-bp1itx13bwe6f2wfh****",
        "Spec": "Large",
        "ChargeType": "PayByTraffic",
        "RouterInterfaceId": "ri-2zenfgfpyu3v93koa****",
        "HcThreshold": 2,
        "OppositeRouterType": "VRouter",
        "VpcInstanceId": "vpc-2ze3tq4uxhysg717x****",
        "OppositeInterfaceOwnerId": "271598332402530847",
        "OppositeVpcInstanceId": "vpc-bp1qpo0kug3a20qqe****",
        "ReservationInternetChargeType": "PayByBandwidth",
        "CrossBorder": false,
        "Bandwidth": 10,
        "Description": "路由表接口描述",
        "HcRate": 1,
        "ReservationBandwidth": "10",
        "Name": "test",
        "OppositeRouterId": "vrt-bp1d3bxtdv68tfd7g****",
        "OppositeInterfaceSpec": "Large",
        "RouterId": "vrt-bp1d3bxtdv68tfd7g****",
        "OppositeInterfaceBusinessStatus": "Normal",
        "ConnectedTime": "2021-06-08T12:20:55",
        "HealthCheckSourceIp": "116.62.XX.XX",
        "OppositeInterfaceStatus": "Normal",
        "EndTime": "2021-06-08T12:20:55",
        "OppositeRegionId": "cn-shanghai",
        "OppositeAccessPointId": "ap-cn-shanghaiSZ-****",
        "BusinessStatus": "Normal",
        "OppositeBandwidth": 12,
        "RouterType": "VRouter",
        "Role": "InitiatingSide",
        "HasReservationData": "false",
        "AccessPointId": "ap-cn-shanghaiSZ-****",
        "Ipv6Status": "on",
        "FastLinkMode": false,
        "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
        "Tags": {
          "Tags": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        }
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParam.NotNull The parameter must not be null.
    400 EndPoint.Empty the rc endpoint is empty.
    400 InvalidConnectionType.MalFormed Connection type must be vpc2vpc or vbr2vpc.
    400 InvalidProductForm.MalFormed Product form must be routerinterface or expressconnect.
    400 InvalidRole.Malformed role must be InitiatingSide or AcceptingSide.
    400 IllegalParam.AliUid Specified value of aliuid invalid.
    400 Parameter.Illegal The parameter is illegal.
    404 InvalidRegionId.NotFound The RegionId provided does not exist in our records.
    404 InvalidFilterKey.ValueNotSupported Specified filter key is not supported: Filter.X.key

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

    変更履歴

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