すべてのプロダクト
Search
ドキュメントセンター

Express Connect:DescribeVirtualBorderRouters

最終更新日:Jun 19, 2026

作成した仮想ボーダールーター(VBR)インスタンスを照会します。

今すぐお試しください

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

list

*VirtualBorderRouter

acs:vpc:{#regionId}:{#AccountId}:virtualborderrouter/{#VbrId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

VBR のリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。

cn-shanghai

PageNumber

integer

任意

リストのページ番号。デフォルト値: 1

1

PageSize

integer

任意

ページングクエリにおける 1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10

10

Filter

array<object>

任意

フィルター情報。

object

任意

フィルター情報。

Key

string

任意

フィルター条件。最大 5 つのフィルター条件を指定できます。以下のフィルター条件がサポートされています:

  • PhysicalConnectionId: Express Connect 回線インスタンスのインスタンス ID。

  • VbrId: 仮想ボーダールーターインスタンスのインスタンス ID。

  • Status: 仮想ボーダールーターのステータス。

  • Name: 仮想ボーダールーターの名前。

  • AccessPointId: アクセスポイントのインスタンス ID。

  • eccId: Express Cloud Connect インスタンスのインスタンス ID。

  • type: Express Connect 回線のタイプ。

Status

Value

array

任意

指定された Key に基づくフィルター値。1 つの Key に対して複数のフィルター値を指定できます。フィルター値間の関係は OR であり、いずれかのフィルター値が一致すれば結果が返されます。

Active

string

任意

指定された Key に基づくフィルター値。1 つの Key に対して複数のフィルター値を指定できます。フィルター値間の関係は OR であり、いずれかのフィルター値が一致すれば結果が返されます。

Active

IncludeCrossAccountVbr

boolean

任意

クロスアカウントの仮想ボーダールーターを含めるかどうかを指定します。

  • true: 含める。

  • false(デフォルト): 含めない。

false

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

VBR 情報。

RequestId

string

リクエスト ID。

DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6

PageNumber

integer

リストのページ番号。デフォルト値: 1

1

PageSize

integer

ページングクエリにおける 1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10

10

TotalCount

integer

返されたエントリの総数。

1

VirtualBorderRouterSet

object

VirtualBorderRouterType

array<object>

照会された VBR のリスト。

array<object>

VBR が作成された時間。

CreationTime

string

仮想ボーダールーターの作成時刻です。

2020-06-08T12:20:55

Status

string

VBR のインスタンスステータスです。

  • unconfirmed: 相手方の確認待ち。

  • active: 正常。

  • terminating: 接続停止中。

  • terminated: 接続停止済み。

  • recovering: 回復中。

  • deleting: 削除中。

active

Type

string

仮想ボーダールーターのタイプです。

pconnVBR

MinTxInterval

integer

BFD メッセージの送信間隔です。有効値は 200~1000 (ミリ秒) です。

300

PeerIpv6GatewayIp

string

仮想ボーダールーターインスタンスのカスタマ側ピア IPv6 アドレスです。

2001:XXXX:3c4d:0015:0000:0000:0000:1a2b

PConnVbrExpireTime

string

課金対象の VBR の有効期限です。

2021-06-08T12:20:55

PhysicalConnectionOwnerUid

string

Express Connect 回線の所有者の Alibaba Cloud アカウント ID です。

1688000000000****

ActivationTime

string

VBR が初めてアクティブ化された時刻です。

2021-06-08T12:20:55

PhysicalConnectionBusinessStatus

string

Express Connect 回線のビジネスステータスです。

  • Normal: 正常。

  • FinancialLocked: 支払いロック。

Normal

Description

string

VBR の説明です。

desc

TerminationTime

string

VBR が直近で停止された時刻です。

2021-06-08T12:20:55

MinRxInterval

integer

BFD メッセージの受信間隔の最小構成値です。有効値は 200~1000 (ミリ秒) です。

300

PeerGatewayIp

string

VBR インスタンスのカスタマ側ピア IPv4 アドレスです。

192.168.XX.XX

Name

string

VBR インスタンスの名前です。

test

VbrId

string

VBR のインスタンス ID です。

vbr-bp1jcg5cmxjbl9xgc****

VlanId

integer

VBR インスタンスの VLAN ID です。

10

VlanInterfaceId

string

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

ri-2zeo3xzyf38r4xx****

CircuitCode

string

Express Connect 回線についてキャリアが提供する回線コードです。

longtel0****

LocalIpv6GatewayIp

string

VBR インスタンスの Alibaba Cloud 側ピア IPv6 アドレスです。

2001:XXXX:3c4d:0015:0000:0000:0000:1a2b

LocalGatewayIp

string

仮想ボーダールーターインスタンスの Alibaba Cloud 側ピア IPv4 アドレスです。

192.168.XX.XX

PeeringSubnetMask

string

VBR インスタンスの Alibaba Cloud 側およびカスタマ側のピア IPv4 アドレスに使用されるサブネットマスクです。

255.255.255.252

EnableIpv6

boolean

IPv6 が有効かどうかを示します。

  • true: 有効。

  • false: 無効。

false

RouteTableId

string

VBR のルートテーブル ID です。

rtb-bp1****

DetectMultiplier

integer

検出倍数です。

この値は、受信側が送信側からの連続パケット損失を許容できる最大回数を表し、リンクの正常性を判断します。

有効値は 3~10 です。

3

EccId

string

Express Cloud Connect インスタンス ID です。

ecc-h****

CloudBoxInstanceId

string

CloudBox インスタンス ID です。

cb-****

RecoveryTime

string

VBR が terminated ステータスから active ステータスに直近で回復した時刻です。

2021-05-08T12:20:55

PhysicalConnectionStatus

string

Express Connect 回線のステータスです。

  • Initial: リクエスト送信中。

  • Approved: 承認済み。

  • Allocating: リソース割り当て中。

  • Allocated: インストール中。

  • Confirmed: ユーザー確認待ち。

  • Enabled: サービスが有効化済み。

  • Rejected: リクエストが拒否されました。

  • Canceled: リクエストがキャンセルされました。

  • Allocation Failed: リソース割り当てに失敗しました。

  • Terminated: サービスが停止されました。

Normal

PeeringIpv6SubnetMask

string

VBR インスタンスの Alibaba Cloud 側およびカスタマ側のピア IPv6 アドレスに使用されるサブネットマスクです。

2000:1234:0:a000::/55

AccessPointId

string

Express Connect 回線アクセスポイントの ID です。

ap-cn-kojok1x****

PConnVbrChargeType

string

Express Connect 回線に接続された仮想ボーダールーターの課金方法です。

  • PrePaid: サブスクリプション。この課金方法を選択する場合、アカウントが残高支払いまたはクレジット支払いをサポートしていることを確認してください。

  • PostPaid: 従量課金。

PrePaid

PhysicalConnectionId

string

VBR が属する Express Connect 回線の ID です。

pc-119mfjzm7x****

AssociatedPhysicalConnections

object

AssociatedPhysicalConnection

array<object>

関連付けられた Express Connect 回線の情報です。

object

関連付けられた Express Connect 回線の情報です。

Status

string

仮想ボーダールーター (VBR) のインスタンスステータスです。

  • unconfirmed: 相手方の確認待ち。

  • active: 正常。

  • terminating: 接続停止中。

  • terminated: 接続停止済み。

  • recovering: 回復中。

  • deleting: 削除中。

active

VlanInterfaceId

string

VBR のルーターインターフェイス ID です。これは VBR ルートのネクストホップとして使用できます。

ri-kojok19x3j0q6k****

CircuitCode

string

Express Connect 回線についてキャリアが割り当てる回線コードです。

longtel0**

PeerIpv6GatewayIp

string

VBR インスタンスのカスタマ側ピア IPv6 アドレスです。

2001:XXXX:3c4d:0015:0000:0000:0000:1a2b

LocalIpv6GatewayIp

string

VBR インスタンスの Alibaba Cloud 側ピア IPv6 アドレスです。

2001:XXXX:3c4d:0015:0000:0000:0000:1a2b

PhysicalConnectionOwnerUid

string

Express Connect 回線所有者の Alibaba Cloud アカウント ID です。

12345678****

LocalGatewayIp

string

VBR インスタンスの Alibaba Cloud 側 IPv4 ピア IP アドレスです。

192.168.XX.XX

PhysicalConnectionBusinessStatus

string

Express Connect 回線のビジネスステータスです。

  • Normal: 正常。

  • FinancialLocked: 支払いロック。

Normal

PeeringSubnetMask

string

VBR インスタンスの Alibaba Cloud 側およびカスタマ側の IPv4 ピア IP アドレスのサブネットマスクです。

2 つの IPv4 アドレスは同じサブネット内に存在する必要があります。

255.255.255.252

EnableIpv6

boolean

IPv6 が有効かどうかを示します。

  • true: 有効。

  • false: 無効。

true

PhysicalConnectionStatus

string

Express Connect 回線のステータスです。

  • Initial: リクエスト処理中。

  • Approved: 承認済み。

  • Allocating: リソース割り当て中。

  • Allocated: アクセスデプロイメント中。

  • Confirmed: ユーザー確認待ち。

  • Enabled: 有効化済み。

  • Rejected: リクエスト拒否。

  • Canceled: キャンセル済み。

  • Allocation Failed: リソース割り当て失敗。

  • Terminated: 停止済み。

Enabled

PeerGatewayIp

string

VBR インスタンスのカスタマ側ピア IPv4 アドレスです。

116.62.XX.XX

PeeringIpv6SubnetMask

string

VBR インスタンスの Alibaba Cloud 側およびカスタマ側の IPv6 ピア IP アドレスのサブネットマスクです。

2 つの IPv6 アドレスは同じサブネット内に存在する必要があります。

2408:4004:cc:400::/56

PhysicalConnectionId

string

Express Connect 回線の ID です。

pc-119mfjzm7****

VlanId

string

VBR インスタンスの VLAN ID です。

0

AssociatedCens

object

AssociatedCen

array<object>

関連付けられた Cloud Enterprise Network (CEN) インスタンスの情報です。

object

インスタンス情報です。

CenOwnerId

integer

CEN インスタンスが属する Alibaba Cloud アカウント ID です。

1688000000000****

CenId

string

CEN インスタンス ID です。

cen-kojok19xxx****

CenStatus

string

Cloud Enterprise Network (CEN) のステータスです。

  • Attached: CEN インスタンスが関連付けられています。

  • Attaching: CEN インスタンスが関連付け中です。

  • Detached: CEN インスタンスが関連付け解除されています。

  • Detaching: CEN インスタンスが関連付け解除中です。

  • empty: CEN インスタンスが関連付けられていません。

Attached

Bandwidth

integer

VBR インスタンスの帯域幅値 (単位: Mbps) です。

50

ResourceGroupId

string

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

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

rg-acfmxazb4ph6aiy****

Tags

object

Tags

array<object>

リソースのタグです。

object

タグです。

Key

string

リソースのタグキーです。

FinanceDept

Value

string

リソースのタグ値です。

FinanceJoshua

EcrId

string

関連付けられた Express Connect Router (ECR) のインスタンス ID です。

ecr-7vrbqv9lcgvzqbwwkm

SitelinkEnable

boolean

IDC 間ビジネスアクセスを許可するかどうかを指定します。有効値は以下のとおりです。

  • true: 許可する。

  • false: 許可しない。

説明

値を指定しない場合、IDC 間ビジネスアクセスは許可されません。

false

EcrAttatchStatus

string

Express Connect Router (ECR) の関連付けステータスです。

  • Attached: 関連付け済み。

  • Attaching: 関連付け中。

  • Detached: 関連付け解除済み。

  • Detaching: 関連付け解除中。

  • empty: 未関連付け。

Attached

EcrOwnerId

string

ECR インスタンスが属する Alibaba Cloud アカウント (プライマリアカウント) ID です。

192732132151xxxx

Mtu

integer

VBR がサポートする MTU 値です。有効値は 1500 および 8500 です。

1500

成功レスポンス

JSONJSON

{
  "RequestId": "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "VirtualBorderRouterSet": {
    "VirtualBorderRouterType": [
      {
        "CreationTime": "2020-06-08T12:20:55",
        "Status": "active",
        "Type": "pconnVBR",
        "MinTxInterval": 300,
        "PeerIpv6GatewayIp": "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
        "PConnVbrExpireTime": "2021-06-08T12:20:55",
        "PhysicalConnectionOwnerUid": "1688000000000****",
        "ActivationTime": "2021-06-08T12:20:55",
        "PhysicalConnectionBusinessStatus": "Normal",
        "Description": "desc",
        "TerminationTime": "2021-06-08T12:20:55",
        "MinRxInterval": 300,
        "PeerGatewayIp": "192.168.XX.XX",
        "Name": "test",
        "VbrId": "vbr-bp1jcg5cmxjbl9xgc****",
        "VlanId": 10,
        "VlanInterfaceId": "ri-2zeo3xzyf38r4xx****",
        "CircuitCode": "longtel0****",
        "LocalIpv6GatewayIp": "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
        "LocalGatewayIp": "192.168.XX.XX",
        "PeeringSubnetMask": "255.255.255.252",
        "EnableIpv6": false,
        "RouteTableId": "rtb-bp1****",
        "DetectMultiplier": 3,
        "EccId": "ecc-h****",
        "CloudBoxInstanceId": "cb-****",
        "RecoveryTime": "2021-05-08T12:20:55",
        "PhysicalConnectionStatus": "Normal",
        "PeeringIpv6SubnetMask": "2000:1234:0:a000::/55",
        "AccessPointId": "ap-cn-kojok1x****",
        "PConnVbrChargeType": "PrePaid",
        "PhysicalConnectionId": "pc-119mfjzm7x****",
        "AssociatedPhysicalConnections": {
          "AssociatedPhysicalConnection": [
            {
              "Status": "active",
              "VlanInterfaceId": "ri-kojok19x3j0q6k****",
              "CircuitCode": "longtel0**",
              "PeerIpv6GatewayIp": "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
              "LocalIpv6GatewayIp": "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
              "PhysicalConnectionOwnerUid": "12345678****",
              "LocalGatewayIp": "192.168.XX.XX",
              "PhysicalConnectionBusinessStatus": "Normal",
              "PeeringSubnetMask": "255.255.255.252",
              "EnableIpv6": true,
              "PhysicalConnectionStatus": "Enabled",
              "PeerGatewayIp": "116.62.XX.XX",
              "PeeringIpv6SubnetMask": "2408:4004:cc:400::/56",
              "PhysicalConnectionId": "pc-119mfjzm7****",
              "VlanId": "0"
            }
          ]
        },
        "AssociatedCens": {
          "AssociatedCen": [
            {
              "CenOwnerId": 0,
              "CenId": "cen-kojok19xxx****",
              "CenStatus": "Attached"
            }
          ]
        },
        "Bandwidth": 50,
        "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
        "Tags": {
          "Tags": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "EcrId": "ecr-7vrbqv9lcgvzqbwwkm",
        "SitelinkEnable": false,
        "EcrAttatchStatus": "Attached",
        "EcrOwnerId": "192732132151xxxx",
        "Mtu": 1500
      }
    ]
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 OperationFailed.InternalError The request processing has failed due to some unknown error.
404 InvalidRegionId.NotFound The RegionId provided does not exist in our records.
404 InvalidFilterKey.ValueNotSupported Specified filter key is not supported: Filter.X.key

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

変更履歴

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