VBR 接続をクエリ - CEN - Alibaba Cloud - Cloud Enterprise Network

ListTransitRouterVbrAttachments を呼び出して、Enterprise Edition トランジットルーターの仮想ボーダールーター (VBR) 接続の情報を照会します。返される情報には、接続の総数、接続ステータス、接続 ID、およびネットワークインスタンスの支払者が含まれます。

操作説明

次のいずれかの方法で、Enterprise Edition トランジットルーターの VBR 接続を照会できます：

トランジットルーターの ID を指定して、すべての VBR 接続を照会します。
Cloud Enterprise Network (CEN) インスタンスの ID とトランジットルーターのリージョン ID を指定して、すべての VBR 接続を照会します。
TransitRouterAttachmentId パラメーターに接続 ID を指定して、特定の 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cen:ListTransitRouterVbrAttachments

list

CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

TransitRouterVbrAttachment

acs:cen:*:{#accountId}:centransitrouterattachment/*

TransitRouterVbrAttachment

acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
CenId	string	任意	CEN インスタンスの ID です。	cen-j3jzhw1zpau2km****
RegionId	string	任意	Enterprise Edition トランジットルーターがデプロイされているリージョンの ID です。 DescribeRegions API を呼び出して、リージョン ID を取得できます。	cn-hangzhou
TransitRouterAttachmentId	string	任意	VBR アタッチメントの ID です。	tr-attach-oyf70wfuorwx87****
TransitRouterId	string	任意	Enterprise Edition トランジットルーターの ID です。	tr-bp1su1ytdxtataupl****
MaxResults	integer	任意	1回のクエリで返される最大エントリ数です。デフォルト値は 20 です。	20
NextToken	string	任意	次のクエリに使用するトークンです。有効な値：初回のクエリの場合、このパラメーターを指定する必要はありません。次のクエリを送信する場合は、前回のリクエストで返された NextToken の値を設定してください。	dd20****
Tag	array<object>	任意	タグです。最大 20 個のタグを指定できます。
	object	任意
Key	string	任意	リソースのタグキーです。タグキーは空の文字列にできません。タグキーは最大 64 文字で、`aliyun` または `acs:` で始めることはできません。タグキーに `http://` または `https://` を含めることはできません。最大 20 個のタグキーを指定できます。	tagtest
Value	string	任意	リソースのタグ値です。タグ値には、空の文字列または最大 128 文字の文字列を指定できます。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。各タグキーは、1 つのタグ値にのみ関連付けることができます。最大 20 個のタグ値を指定できます。	tagtest

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
NextToken	string	次のクエリに使用するトークンです。このパラメーターが空の場合、これ以上データは返されません。このパラメーターに値が返された場合、その値は次のページの結果を取得するためのトークンです。	dd20****
RequestId	string	リクエスト ID です。	F42D9616-29EB-4E75-8CA8-9654D4E07501
TotalCount	integer	返されたエントリの総数です。	1
MaxResults	integer	1 ページあたりに返されるエントリの最大数です。	20
TransitRouterAttachments	array<object>	VBR 接続のリストです。
	array<object>
CreationTime	string	VBR 接続が作成された時刻です。時刻は YYYY-MM-DDThh:mmZ 形式の UTC で表示されます。	2021-06-15T15:20Z
Status	string	VBR 接続のステータスです。 Attached：接続が確立されています。 Attaching：接続を確立中です。 Detaching：接続を解除中です。	Attached
TransitRouterAttachmentId	string	VBR 接続の ID です。	tr-attach-oyf70wfuorwx87****
TransitRouterId	string	Enterprise Edition トランジットルーターの ID です。	tr-bp1su1ytdxtataupl****
ResourceType	string	接続のリソースタイプです。値は VBR で、VBR インスタンスを示します。	VBR
VbrRegionId	string	VBR がデプロイされているリージョンの ID です。	cn-hangzhou
TransitRouterAttachmentDescription	string	VBR 接続の説明です。	testdesc
VbrOwnerId	integer	VBR が属する Alibaba Cloud アカウントの ID です。	1688111111111111
AutoPublishRouteEnabled	boolean	Enterprise Edition トランジットルーターが VBR にルートを自動的にアドバタイズするかどうかを示します。 false：いいえ。 true：はい。	false
VbrId	string	VBR の ID です。	vbr-bp1svadp4lq38janc****
TransitRouterAttachmentName	string	VBR 接続の名前です。	testa
Tags	array<object>	タグのリストです。
	object
Key	string	タグキーです。	test
Value	string	タグ値です。	value_A1
CenId	string	CEN インスタンスの ID です。	cen-j3jzhw1zpau2km****
ManagedService	string
OrderType	string	ネットワークインスタンスの支払者です。有効な値： PayByCenOwner：VBR の接続料金とデータ転送料金は、トランジットルーターを所有するアカウントが支払います。 PayByResourceOwner：VBR の接続料金とデータ転送料金は、VBR を所有するアカウントが支払います。	PayByCenOwner

例

成功レスポンス

JSONJSON

{
  "NextToken": "dd20****",
  "RequestId": "F42D9616-29EB-4E75-8CA8-9654D4E07501",
  "TotalCount": 1,
  "MaxResults": 20,
  "TransitRouterAttachments": [
    {
      "CreationTime": "2021-06-15T15:20Z",
      "Status": "Attached",
      "TransitRouterAttachmentId": "tr-attach-oyf70wfuorwx87****",
      "TransitRouterId": "tr-bp1su1ytdxtataupl****",
      "ResourceType": "VBR",
      "VbrRegionId": "cn-hangzhou",
      "TransitRouterAttachmentDescription": "testdesc",
      "VbrOwnerId": 1688111111111111,
      "AutoPublishRouteEnabled": false,
      "VbrId": "vbr-bp1svadp4lq38janc****",
      "TransitRouterAttachmentName": "testa",
      "Tags": [
        {
          "Key": "test",
          "Value": "value_A1"
        }
      ],
      "CenId": "cen-j3jzhw1zpau2km****\n",
      "ManagedService": "",
      "OrderType": "PayByCenOwner"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IllegalParam.NextToken	The specified NextToken is invalid.
400	IllegalParam.TrInstance	The specified TransitRouter is invalid.
400	IllegalParam.Region	The specified Region is invalid.
400	IllegalParam.CenId	The specified CenId is invalid.
400	IllegalParam.TransitRouterId	The specified TransitRouterId is invalid.
400	IllegalParam.CenIdOrRegionId	The specified CenId or RegionId is invalid.
400	IllegalParam.MaxResults	The specified MaxResults is illegal.
400	InvalidParameter	Invalid parameter.
400	Unauthorized	The AccessKeyId is unauthorized.

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

変更履歴

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