すべてのプロダクト
Search

このプロダクト

    Virtual Private Cloud:DescribeRouterInterfaceAttribute

    ドキュメントセンター

    Virtual Private Cloud:DescribeRouterInterfaceAttribute

    最終更新日:Aug 13, 2026

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

    今すぐお試しください

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

    get

    *RouterInterface。

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

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

    cn-qingdao
    InstanceId

    string

    必須

    クエリするルーターインターフェイスの ID。

    ri-m5egfc10sednwk2yt****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    ReservationActiveTime

    string

    更新の有効化時刻。時刻は ISO 8601 標準の YYYY-MM-DDThh:mm:ssZ フォーマットで表示されます。時刻は協定世界時 (UTC) で表示されます。

    2022-06-11T16:00:00Z
    HealthCheckTargetIp

    string

    ヘルスチェックのターゲット IP アドレス。

    2.2.XX.XX
    Status

    string

    ルーターインターフェイスのステータス。有効な値:

    Active
    CreationTime

    string

    ルーターインターフェイスが作成された時刻。時刻は ISO 8601 標準の YYYY-MM-DDThh:mm:ssZ フォーマットで表示されます。時刻は協定世界時 (UTC) で表示されます。

    2022-04-14T08:57:24Z
    ReservationOrderType

    string

    更新注文のタイプ。有効な値: RENEW (更新注文を示します)。

    RENEW
    OppositeInterfaceId

    string

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

    ri-bp1xkrzttximaoxbl****
    Spec

    string

    ルーターインターフェイスのスペック。有効な値:

    Mini.2
    ChargeType

    string

    課金方法。有効な値:

    AfterPay
    RouterInterfaceId

    string

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

    ri-m5egfc10sednwk2yt****
    Message

    string

    返されるメッセージ。

    successful
    HcThreshold

    integer

    ヘルスチェックのしきい値。この値は、ヘルスチェック中に送信されるプローブパケットの数を示します。単位: パケット。

    8
    OppositeRouterType

    string

    ピアルーターインターフェイスが属するルーターのタイプ。有効な値:

    VRouter
    GmtModified

    string

    ルーターインターフェイスが最後に変更された時刻。

    2022-04-28T10:02:12Z
    VpcInstanceId

    string

    ルーターインターフェイスが属する Virtual Private Cloud (VPC) の ID。

    vpc-bp1b49rqrybk45nio****
    OppositeInterfaceOwnerId

    string

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

    1321932713****
    OppositeVpcInstanceId

    string

    ピア VPC の ID。

    vpc-bp1b49rqrybk45nio****
    ReservationInternetChargeType

    string

    更新の課金タイプ。有効な値: PayByBandwidth (帯域幅課金を示します)。

    PayByBandwidth
    CrossBorder

    boolean

    接続が国境を越えた接続かどうかを示します。有効な値:

    false
    RequestId

    string

    リクエスト ID。

    01818199-04F6-47F4-9ADF-7CC824CF57A4
    Bandwidth

    integer

    ルーターインターフェイスの帯域幅。単位: Mbps。

    2
    Description

    string

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

    ピアインターフェイス
    HcRate

    integer

    ヘルスチェックのレート。単位: 秒。この値は、ヘルスチェック中に送信される連続したプローブパケットの間隔を示します。

    2
    ReservationBandwidth

    string

    更新帯域幅。単位: Mbps。

    100
    Code

    string

    HTTP 状態コード。

    200
    Name

    string

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

    RouterInterface1
    OppositeRouterId

    string

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

    vrt-bp11xvy6lb9photuu****
    OppositeInterfaceSpec

    string

    ピアルーターインターフェイスのスペック。有効な値:

    Negative
    RouterId

    string

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

    vbr-m5ex0xf63xk8s5bob****
    Success

    boolean

    呼び出しが成功したかどうかを示します。

    true
    OppositeInterfaceBusinessStatus

    string

    ピアルーターインターフェイスのビジネスステータス。有効な値:

    法線
    ConnectedTime

    string

    接続が確立された時刻。時刻は ISO 8601 標準の YYYY-MM-DDThh:mm:ssZ フォーマットで表示されます。時刻は協定世界時 (UTC) で表示されます。

    2022-04-14T08:58:04Z
    HealthCheckSourceIp

    string

    ヘルスチェックのソース IP アドレス。

    1.1.XX.XX
    OppositeInterfaceStatus

    string

    ピアルーターインターフェイスのステータス。有効な値:

    Active
    EndTime

    string

    データ取得の終了時刻。時刻は ISO 8601 標準の YYYY-MM-DDThh:mm:ssZ フォーマットで表示されます。時刻は協定世界時 (UTC) で表示されます。

    2999-09-08T16:00:00Z
    OppositeRegionId

    string

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

    cn-hangzhou
    OppositeAccessPointId

    string

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

    ap-cn-qingdao-ls-B
    BusinessStatus

    string

    ルーターインターフェイスのビジネスステータス。有効な値:

    法線
    HealthCheckStatus

    string

    ヘルスチェックのステータス。有効な値:

    normal
    OppositeBandwidth

    integer

    ピアルーターインターフェイスの帯域幅。単位: Mbps。

    0
    RouterType

    string

    ルートテーブルが属するルーターのタイプ。有効な値:

    VRouter
    Role

    string

    ピアリング接続におけるロール。

    InitiatingSide
    HasReservationData

    string

    更新データが存在するかどうかを示します。有効な値:

    false
    AccessPointId

    string

    アクセスポイントの ID。

    ap-cn-qingdao-ls-A
    ResourceGroupId

    string

    リソースグループの ID。

    rg-acfmxazb4ph6aiy****
    Tags

    object

    Tags

    array<object>

    リソースのタグ。

    object

    タグ。

    Key

    string

    リソースのタグキー。少なくとも 1 つのタグキーを指定する必要があり、最大 20 個のタグキーを指定できます。タグキーを空文字列にすることはできません。

    FinanceDept
    Value

    string

    リソースのタグ値。最大 20 個のタグ値を指定できます。タグ値は空文字列にすることができます。

    FinanceJoshua
    FastLinkMode

    string

    VBR 上のルーターインターフェイスが高速リンクモードで作成されたかどうかを示します。高速リンクモードでは、VBR および VPC 上のルーターインターフェイスが作成後に自動的に接続されます。有効な値:

    false

    例

    成功レスポンス

    JSONJSON

    {
  "ReservationActiveTime": "2022-06-11T16:00:00Z",
  "HealthCheckTargetIp": "2.2.XX.XX",
  "Status": "Active",
  "CreationTime": "2022-04-14T08:57:24Z",
  "ReservationOrderType": "RENEW",
  "OppositeInterfaceId": "ri-bp1xkrzttximaoxbl****",
  "Spec": "Mini.2",
  "ChargeType": "AfterPay",
  "RouterInterfaceId": "ri-m5egfc10sednwk2yt****",
  "Message": "successful",
  "HcThreshold": 8,
  "OppositeRouterType": "VRouter",
  "GmtModified": "2022-04-28T10:02:12Z",
  "VpcInstanceId": "vpc-bp1b49rqrybk45nio****",
  "OppositeInterfaceOwnerId": "1321932713****",
  "OppositeVpcInstanceId": "vpc-bp1b49rqrybk45nio****",
  "ReservationInternetChargeType": "PayByBandwidth",
  "CrossBorder": false,
  "RequestId": "01818199-04F6-47F4-9ADF-7CC824CF57A4",
  "Bandwidth": 2,
  "Description": "ピアルーターインターフェイス",
  "HcRate": 2,
  "ReservationBandwidth": "100",
  "Code": "200",
  "Name": "RouterInterface1",
  "OppositeRouterId": "vrt-bp11xvy6lb9photuu****",
  "OppositeInterfaceSpec": "Negative",
  "RouterId": "vbr-m5ex0xf63xk8s5bob****",
  "Success": true,
  "OppositeInterfaceBusinessStatus": "法線",
  "ConnectedTime": "2022-04-14T08:58:04Z",
  "HealthCheckSourceIp": "1.1.XX.XX",
  "OppositeInterfaceStatus": "Active",
  "EndTime": "2999-09-08T16:00:00Z",
  "OppositeRegionId": "cn-hangzhou",
  "OppositeAccessPointId": "ap-cn-qingdao-ls-B",
  "BusinessStatus": "法線",
  "HealthCheckStatus": "normal",
  "OppositeBandwidth": 0,
  "RouterType": "VRouter",
  "Role": "InitiatingSide",
  "HasReservationData": "false",
  "AccessPointId": "ap-cn-qingdao-ls-A",
  "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
  "Tags": {
    "Tags": [
      {
        "Key": "FinanceDept",
        "Value": "FinanceJoshua"
      }
    ]
  },
  "FastLinkMode": "false"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParam.NotNull The parameter must not be null.

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

    変更履歴

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