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

ListTransitRouterVpcAttachments API では、Enterprise Edition のトランジットルーターにおける VPC 接続について、接続ステータス、課金方法、ゾーン、および接続先 VPC の vSwitch と Elastic Network Interface (ENI) などの詳細をクエリします。

操作説明

Enterprise Edition トランジットルーターの VPC 接続を照会するには、次のいずれかの方法があります。

Enterprise Edition トランジットルーターインスタンスの ID を指定して、そのすべての VPC 接続を照会します。
Cloud Enterprise Network (CEN) インスタンスの ID と Enterprise Edition トランジットルーターインスタンスのリージョン ID を指定して、そのすべての VPC 接続を照会します。
Enterprise Edition トランジットルーターインスタンスを含むリージョンの ID を指定して、そのリージョン内のすべての VPC 接続を照会します。

今すぐお試しください

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

list

*CenInstance

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

TransitRouterVpcAttachment

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

TransitRouterVpcAttachment

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
CenId	string	任意	CEN インスタンスの ID。	cen-j3jzhw1zpau2km****
RegionId	string	任意	Enterprise Edition トランジットルーターがデプロイされているリージョンの ID。 DescribeRegions API を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
TransitRouterAttachmentId	string	任意	VPC アタッチメントの ID。	tr-attach-nls9fzkfat8934****
TransitRouterId	string	任意	Enterprise Edition トランジットルーターの ID。	tr-bp1su1ytdxtataupl****
MaxResults	integer	任意	各ページで返されるエントリ数。デフォルト値は 20 です。	20
NextToken	string	任意	次のリクエストで結果の次ページを取得するために使用するページネーショントークンです。初回のクエリの場合、または利用可能な結果がこれ以上ない場合、このパラメーターを指定する必要はありません。後続のクエリでは、前回のレスポンスの `NextToken` の値をこのパラメーターに設定します。	FFmyTO70tTpLG6I3FmYAXGKPd****
Tag	array<object>	任意	タグ。最大 20 個のタグを指定できます。
	object	任意
Key	string	任意	タグキー。タグキーの長さは 1 ～ 64 文字である必要があります。また、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。	tagtest
Value	string	任意	タグ値。タグ値の長さは 0 ～ 128 文字です。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。	tagtest
VpcId	string	任意	VPC の ID。	vpc-bp1kbjcre9vtsebo1****
OrderType	string	任意	ネットワークインスタンスの料金を支払うエンティティ。有効な値： PayByCenOwner：料金は CEN インスタンスを所有するアカウントが支払います。 PayByResourceOwner：料金はネットワークインスタンスを所有するアカウントが支払います。	PayByCenOwner
Status	string	任意	VPC アタッチメントのステータス。有効な値： Attaching：VPC アタッチメントを作成中です。 Attached：VPC アタッチメントは作成済みです。 Detaching：VPC アタッチメントを削除中です。	Attached

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
NextToken	string	次の結果ページを取得するためのトークン。このパラメーターが空の場合、すべての結果が返されたことを示します。 NextToken に値が返された場合、その値が次のクエリを開始するためのトークンです。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	リクエスト ID。	C97FF53F-3EF8-4883-B459-60E171924B23
TotalCount	integer	エントリの総数。	1
MaxResults	integer	各ページで返されるエントリ数。	20
TransitRouterAttachments	array<object>	VPC アタッチメントのリスト。
	array<object>
CreationTime	string	VPC アタッチメントが作成された時刻。時刻は UTC で、`YYYY-MM-DDThh:mmZ` 形式です。	2021-06-15T02:14Z
Status	string	VPC アタッチメントのステータス。 Attached：接続が確立されています。 Attaching：接続が作成中です。 Detaching：接続が削除中です。	Attached
VpcId	string	Virtual Private Cloud (VPC) の ID。	vpc-bp1h8vbrbcgohcju5****
TransitRouterAttachmentId	string	VPC アタッチメントの ID。	tr-attach-nls9fzkfat8934****
TransitRouterId	string	Enterprise Edition トランジットルーターの ID。	tr-bp1su1ytdxtataupl****
ResourceType	string	アタッチ先のリソースタイプ。値は常に VPC で、Virtual Private Cloud (VPC) を示します。	VPC
TransitRouterAttachmentDescription	string	VPC アタッチメントの説明。	testdesc
VpcOwnerId	integer	VPC を所有するアカウントの ID。	1250123456123456
VpcRegionId	string	VPC がデプロイされているリージョンの ID。	cn-hangzhou
TransitRouterAttachmentName	string	VPC アタッチメントの名前。	testname
ZoneMappings	array<object>	VPC アタッチメントのゾーンマッピング。これには、関連付けられた VPC 内の vSwitch と Elastic Network Interface (ENI) が含まれます。
	object
ZoneId	string	アベイラビリティーゾーンの ID。	cn-hangzhou-h
VSwitchId	string	vSwitch の ID。	vsw-bp1a214sbus8z3b54****
NetworkInterfaceId	string	Enterprise Edition トランジットルーターが vSwitch に作成する Elastic Network Interface (ENI) の ID。	eni-bp149hmyaqegerml****
AutoPublishRouteEnabled	boolean	Enterprise Edition トランジットルーターが VPC にルートを自動的にアドバタイズするかどうかを示します。 false：ルートは自動的にアドバタイズされません。 true：ルートは自動的にアドバタイズされます。	true
ChargeType	string	VPC アタッチメントの課金方法。値は常に POSTPAY で、従量課金を示します。	POSTPAY
Tags	array<object>	タグのリスト。
	object
Key	string	タグキー。	test
Value	string	タグ値。	test
OrderType	string	ネットワークインスタンスの料金負担者を指定します。有効な値： PayByCenOwner：Cloud Enterprise Network (CEN) インスタンスを所有するアカウントが料金を支払います。 PayByResourceOwner：ネットワークインスタンスを所有するアカウントが料金を支払います。	PayByCenOwner
ManagedService	string	リソースが属するクラウドサービス。	SAS
TransitRouterVPCAttachmentOptions	object	VPC アタッチメントの機能属性。このパラメーターは非推奨です。代わりに Options パラメーターを使用することを推奨します。
	string	ipv6Support：IPv6 が有効かどうかを示します。この設定のデフォルト値は、VPC アタッチメントの現在の IPv6 ステータスです。 enable：IPv6 は有効です。 disable：IPv6 は無効です。	{ "ipv6Support": "disable" }
CenId	string	Cloud Enterprise Network (CEN) インスタンスの ID。	cen-j3jzhw1zpau2km****
Options	object	機能属性のコレクション。
Ipv6Support	string	IPv6 が有効かどうかを示します。 disable (デフォルト)：IPv6 は無効です。 enable：IPv6 は有効です。
ApplianceModeSupport	string	アプライアンスモードが有効かどうかを示します。 disable (デフォルト)：アプライアンスモードは無効です。 enable：アプライアンスモードは有効です。

例

成功レスポンス

JSONJSON

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "C97FF53F-3EF8-4883-B459-60E171924B23",
  "TotalCount": 1,
  "MaxResults": 20,
  "TransitRouterAttachments": [
    {
      "CreationTime": "2021-06-15T02:14Z",
      "Status": "Attached",
      "VpcId": "vpc-bp1h8vbrbcgohcju5****",
      "TransitRouterAttachmentId": "tr-attach-nls9fzkfat8934****",
      "TransitRouterId": "tr-bp1su1ytdxtataupl****",
      "ResourceType": "VPC",
      "TransitRouterAttachmentDescription": "testdesc",
      "VpcOwnerId": 1250123456123456,
      "VpcRegionId": "cn-hangzhou",
      "TransitRouterAttachmentName": "testname",
      "ZoneMappings": [
        {
          "ZoneId": "cn-hangzhou-h",
          "VSwitchId": "vsw-bp1a214sbus8z3b54****",
          "NetworkInterfaceId": "eni-bp149hmyaqegerml****"
        }
      ],
      "AutoPublishRouteEnabled": true,
      "ChargeType": "POSTPAY",
      "Tags": [
        {
          "Key": "test",
          "Value": "test"
        }
      ],
      "OrderType": "PayByCenOwner",
      "ManagedService": "SAS",
      "TransitRouterVPCAttachmentOptions": {
        "key": "{ \"ipv6Support\": \"disable\" }"
      },
      "CenId": "cen-j3jzhw1zpau2km****\n",
      "Options": {
        "Ipv6Support": "",
        "ApplianceModeSupport": ""
      }
    }
  ]
}

エラーコード

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.

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

変更履歴

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