DescribeVirtualBorderRouters - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

説明

この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに Vpc(2016-04-28) - DescribeVirtualBorderRouters への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

今すぐお試しください

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

get

*VirtualBorderRouter

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョンIDです。
PageNumber	integer	任意	リストのページ番号です。デフォルト値：1。
PageSize	integer	任意	1ページあたりの行数です。最大値：50。デフォルト値：10。
Filter	array<object>	任意	フィルター条件のリストです。最大 5つのフィルター条件を指定できます。
	object	任意	フィルター条件です。
Key	string	任意	フィルター条件のキーです。
Value	array	任意	フィルター条件に対応する値のリストです。最大 5つの値を指定できます。
	string	任意	フィルター条件に対応する値です。

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストIDです。
PageNumber	integer	リストのページ番号です。
PageSize	integer	1ページあたりの行数です。
TotalCount	integer	クエリ結果の総件数です。
VirtualBorderRouterSet	object	仮想ボーダールーター（VBR）の情報のリストです。
VirtualBorderRouterType	array<object>	仮想ボーダールーターの詳細情報です。
	object	仮想ボーダールーターの情報です。
VlanInterfaceId	string	VBR インターフェイスの ID です。
Status	string	VBR のステータスです。有効な値は次のとおりです： `active` `deactivating` `creating` `terminating` `terminated`
CreationTime	string	VBR が作成された時刻 (UTC) です。
CircuitCode	string	接続プロバイダーから提供される、物理接続のサーキットコードです。
PhysicalConnectionOwnerUid	string	物理接続の所有者のアカウント ID です。
LocalGatewayIp	string	オンプレミスデータセンターにあるローカルゲートウェイの IP アドレスです。
ActivationTime	string	VBR が最初にアクティベートされた時刻 (UTC) です。
PhysicalConnectionBusinessStatus	string	物理接続のビジネスステータスです。有効な値は次のとおりです： `Normal` ：物理接続は正常に稼働しています。 `FinancialLocked` ：物理接続は支払い遅延によりロックされています。
PeeringSubnetMask	string	VBR とローカルゲートウェイのピアリング IP アドレスのサブネットマスクです。
RouteTableId	string	VBR に関連付けられているルートテーブルの ID です。
Description	string	VBR の説明です。
PhysicalConnectionStatus	string	物理接続のステータスです。有効な値は次のとおりです： `Initial` `Approved` `Allocating` `Allocated` `Confirmed` `Enabled` `Rejected` `Canceled` `Allocation Failed` `Terminated`
RecoveryTime	string	VBR が最後に障害から復旧した時刻 (UTC) です。
TerminationTime	string	VBR が終了した時刻 (UTC) です。
PeerGatewayIp	string	Alibaba Cloud 側のピアゲートウェイの IP アドレスです。
Name	string	VBR の名前です。
AccessPointId	string	アクセスポイントの ID です。
VbrId	string	VBR の ID です。
PhysicalConnectionId	string	物理接続の ID です。
VlanId	integer	VBR の VLAN ID です。

例

成功レスポンス

JSONJSON

{
  "RequestId": "",
  "PageNumber": 0,
  "PageSize": 0,
  "TotalCount": 0,
  "VirtualBorderRouterSet": {
    "VirtualBorderRouterType": [
      {
        "VlanInterfaceId": "",
        "Status": "",
        "CreationTime": "",
        "CircuitCode": "",
        "PhysicalConnectionOwnerUid": "",
        "LocalGatewayIp": "",
        "ActivationTime": "",
        "PhysicalConnectionBusinessStatus": "",
        "PeeringSubnetMask": "",
        "RouteTableId": "",
        "Description": "",
        "PhysicalConnectionStatus": "",
        "RecoveryTime": "",
        "TerminationTime": "",
        "PeerGatewayIp": "",
        "Name": "",
        "AccessPointId": "",
        "VbrId": "",
        "PhysicalConnectionId": "",
        "VlanId": 0
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key

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

変更履歴

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