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

Enterprise Edition トランジットルーター配下の VPC 接続に関する情報を照会します。これには、トラフィックの転送およびルーティングがアクティブな VPC 接続のステータス、課金タイプ、ゾーン情報、関連付けられた vSwitch およびネットワークインターフェースの詳細が含まれます。

操作説明

次の 3 つの方法で、Enterprise Edition トランジットルーター配下の VPC 接続に関する情報をクエリできます。

トランジットルーターインスタンス ID を指定して、Enterprise Edition トランジットルーターインスタンス配下のすべての VPC 接続に関する情報をクエリします。
CEN インスタンス ID と Enterprise Edition トランジットルーターインスタンスのリージョン ID を指定して、Enterprise Edition トランジットルーターインスタンス配下のすべての 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 エディションのトランジットルーターインスタンスのリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。	cn-hangzhou
TransitRouterAttachmentId	string	任意	VPC 接続の ID。	tr-attach-nls9fzkfat8934****
TransitRouterId	string	任意	Enterprise エディションのトランジットルーターインスタンスの ID。	tr-bp1su1ytdxtataupl****
MaxResults	integer	任意	ページングクエリの 1 ページあたりのエントリ数。デフォルト値: 20。	20
NextToken	string	任意	次のクエリのトークン。有効な値: 最初のクエリの場合、または次のクエリが存在しない場合は、このパラメーターを指定する必要はありません。次のクエリが存在する場合は、このパラメーターを前の API 呼び出しで返された NextToken 値に設定します。	FFmyTO70tTpLG6I3FmYAXGKPd****
Tag	array<object>	任意	タグ情報。一度に最大 20 個のタグを指定できます。
	object	任意
Key	string	任意	リソースのタグキー。指定した場合、タグキーを空文字列にすることはできません。タグキーの長さは最大 64 文字で、`aliyun` または `acs:` で始めることはできません。また、`http://` または `https://` を含めることはできません。一度に最大 20 個のタグキーを指定できます。	tagtest
Value	string	任意	リソースのタグ値。タグ値は空でも、最大 128 文字の文字列でも構いません。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。各タグキーは 1 つのタグ値に対応します。一度に最大 20 個のタグ値を指定できます。	tagtest
VpcId	string	任意	VPC インスタンスの ID。	vpc-bp1kbjcre9vtsebo1****
OrderType	string	任意	ネットワークインスタンスの支払者。有効な値: PayByCenOwner: ネットワークインスタンスによって生成される料金は、CEN インスタンスを所有するアカウントによって支払われます。 PayByResourceOwner: ネットワークインスタンスによって生成される料金は、ネットワークインスタンスを所有するアカウントによって支払われます。	PayByCenOwner
Status	string	任意	ネットワークインスタンスの添付ファイルのステータス。 Attaching: 添付中。 Attached: 添付済み。 Detaching: 分離中。	Attached

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
NextToken	string	次のクエリのトークン。有効な値: NextToken が空の場合、次のクエリは存在しません。 NextToken が返された場合、その値は次のクエリのトークンを示します。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	リクエスト ID。	C97FF53F-3EF8-4883-B459-60E171924B23
TotalCount	integer	エントリの総数。	1
MaxResults	integer	ページングクエリの 1 ページあたりのエントリ数。	20
TransitRouterAttachments	array<object>	VPC 接続のリスト。
	array<object>	VPC 接続のリスト。
CreationTime	string	VPC 接続が作成された時間。時間は ISO 8601 標準の協定世界時 (UTC) で表示されます。フォーマット: YYYY-MM-DDThh:mmZ。	2021-06-15T02:14Z
Status	string	VPC 接続のステータス。 Attached: 添付済み。 Attaching: 添付中。 Detaching: 分離中。	Attached
VpcId	string	VPC インスタンスの ID。	vpc-bp1h8vbrbcgohcju5****
TransitRouterAttachmentId	string	VPC 接続の ID。	tr-attach-nls9fzkfat8934****
TransitRouterId	string	Enterprise Edition トランジットルーターインスタンスの ID。	tr-bp1su1ytdxtataupl****
ResourceType	string	接続のリソースタイプ。値は VPC で、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 とネットワークインターフェースの情報。
	object
ZoneId	string	ゾーンの ID。	cn-hangzhou-h
VSwitchId	string	vSwitch の ID。	vsw-bp1a214sbus8z3b54****
NetworkInterfaceId	string	トラフィックの転送とルーティングのために Enterprise Edition トランジットルーターが vSwitch に作成したネットワークインターフェースの 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: ネットワークインスタンスによって生成される料金は、CEN インスタンスを所有するアカウントによって支払われます。 PayByResourceOwner: ネットワークインスタンスによって生成される料金は、ネットワークインスタンスを所有するアカウントによって支払われます。	PayByCenOwner
ManagedService	string	接続が属するクラウドサービス。	SAS
TransitRouterVPCAttachmentOptions	object	VPC 接続の特徴属性のリスト (非推奨予定。代わりに新しいパラメーター Options を使用してください)。
	string	VPC 接続の特徴属性 (非推奨予定。代わりに新しいパラメーター Options を使用してください)。 ipv6Support: IPv6 が有効かどうかを示します。デフォルト値は VPC 接続の現在の IPv6 ステータスです。 enable: IPv6 が有効です。 disable: IPv6 が無効です。	{ "ipv6Support": "disable" }
CenId	string	CEN インスタンスの ID。	cen-j3jzhw1zpau2km****
Options	object	特徴属性のコレクション。
Ipv6Support	string	IPv6 が有効かどうかを示します。 disable (デフォルト): いいえ。 enable: はい。	enable
ApplianceModeSupport	string	アプライアンスモードが有効かどうかを示します。 disable (デフォルト): いいえ。 enable: はい。	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": "enable",
        "ApplianceModeSupport": "enable"
      }
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	IllegalParam.NextToken	The specified NextToken is invalid.	リクエストで指定された NextToken が無効です。
400	IllegalParam.TrInstance	The specified TransitRouter is invalid.	TransitRouterId または RegionId パラメーターが無効です。
400	IllegalParam.Region	The specified Region is invalid.	リクエストで指定された Region が無効です。
400	IllegalParam.CenId	The specified CenId is invalid.	指定された cenId が無効です。
400	IllegalParam.TransitRouterId	The specified TransitRouterId is invalid.	TransitRouterId または RegionId パラメーターが無効です。
400	IllegalParam.CenIdOrRegionId	The specified CenId or RegionId is invalid.	指定された CenId または RegionId が無効です。
400	IllegalParam.MaxResults	The specified MaxResults is illegal.	MaxResults の値が無効です。
400	InvalidParameter	Invalid parameter.	パラメーターが無効です。
400	Unauthorized	The AccessKeyId is unauthorized.	アカウントにこの操作を実行する権限がありません。

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

変更履歴

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