CreateTransitRouter - Cloud Enterprise Network - Alibaba Cloud ドキュメントセンター

CreateTransitRouter 操作を呼び出して、Enterprise Edition トランジットルーターインスタンスを作成できます。

操作説明

CreateTransitRouter 操作を呼び出して、Enterprise Edition トランジットルーターインスタンスを作成できます。 Enterprise Edition トランジットルーターは一部のリージョンでのみ利用可能です。サポートされているリージョンの詳細については、「クラウドエンタープライズネットワークとは」をご参照ください。
CreateTransitRouter は非同期操作です。リクエストを送信すると、システムは Enterprise Edition トランジットルーターインスタンス ID を返しますが、インスタンスはまだバックグラウンドで作成されています。 ListTransitRouters 操作を呼び出して、Enterprise Edition トランジットルーターインスタンスのステータスをクエリできます。
- Enterprise Edition トランジットルーターインスタンスが Creating 状態の場合、インスタンスのクエリのみが可能で、他の操作は実行できません。
- Enterprise Edition トランジットルーターインスタンスが Active 状態の場合、インスタンスは作成されています。
CEN インスタンスの各リージョンに作成できるトランジットルーターインスタンスは 1 つだけです。

今すぐお試しください

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

create

CenInstance

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

TransitRouter

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

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。異なるリクエスト間でトークンが一意になるように、クライアントトークンを生成します。トークンには ASCII 文字のみを含めることができます。説明このパラメータを指定しない場合、システムはリクエストの RequestId を ClientToken として自動的に使用します。 RequestId はリクエストごとに異なる場合があります。	02fb3da4-130e-11e9-8e44-001****
CenId	string	必須	CEN インスタンスの ID。	cen-j3jzhw1zpau2km****
RegionId	string	必須	Enterprise Edition トランジットルーターがデプロイされているリージョンの ID。 DescribeChildInstanceRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-zhangjiakou
TransitRouterName	string	任意	Enterprise Edition トランジットルーターインスタンスの名前。名前は空にするか、1 ～ 128 文字の長さにできます。 http:// または https:// で始めることはできません。	testname
TransitRouterDescription	string	任意	Enterprise Edition トランジットルーターインスタンスの説明。説明は空にするか、1 ～ 256 文字の長さにできます。 http:// または https:// で始めることはできません。	testdesc
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。ドライランでは、権限と必須パラメータが指定されているかどうかを確認します。有効な値: false (デフォルト): リクエストを送信し、リクエストがチェックに合格した後にインスタンスを作成します。 true: インスタンスを作成せずにパラメータをチェックするためのドライランリクエストを送信します。システムは必須パラメータ、リクエストフォーマット、および権限をチェックします。リクエストがドライランに失敗した場合、エラーメッセージが返されます。リクエストがドライランに合格した場合、`DryRunOperation` エラーコードが返されます。	false
SupportMulticast	boolean	任意	Enterprise Edition トランジットルーターのマルチキャスト機能を有効にするかどうかを指定します。有効な値: false (デフォルト): マルチキャスト機能を無効にします。 true: マルチキャスト機能を有効にします。マルチキャスト機能は、一部のリージョンでのみサポートされています。 ListTransitRouterAvailableResource 操作を呼び出して、マルチキャストをサポートするリージョンをクエリできます。	false
TransitRouterCidrList	array<object>	任意	トランジットルーターの CIDR ブロック。
	object	任意	トランジットルーターの CIDR ブロック。最大 5 つの CIDR ブロックを追加できます。トランジットルーターの CIDR ブロックの詳細については、「トランジットルーターの CIDR ブロック」をご参照ください。説明 Enterprise Edition トランジットルーターのみが CIDR ブロックをサポートしています。
Cidr	string	任意	トランジットルーターの CIDR ブロック。	192.168.10.0/24
Name	string	任意	CIDR ブロックの名前。名前は 1 ～ 128 文字の長さでなければなりません。	nametest
Description	string	任意	CIDR ブロックの説明。説明は 1 ～ 256 文字の長さでなければなりません。	desctest
PublishCidrRoute	boolean	任意	CIDR ブロックのルートをトランジットルーターのルートテーブルに自動的にアドバタイズするかどうかを指定します。 true (デフォルト): はい。このオプションを選択すると、プライベートゲートウェイを使用する VPN 接続を作成し、VPN 接続のルート学習相関を作成した後、システムは VPN 接続が関連付けられているトランジットルーターのルートテーブルに次のルートを自動的に追加します。宛先 CIDR ブロックがトランジットルーターの CIDR ブロックであるブラックホールルート。トランジットルーターの CIDR ブロックとは、ゲートウェイ IP アドレスが IPsec 接続に割り当てられる CIDR ブロックを指します。このブラックホールルートは、トランジットルーターに接続されている仮想ボーダールータ (VBR) インスタンスのルートテーブルにのみアドバタイズされます。 false: いいえ。	true
Tag	array<object>	任意	タグ。
	object	任意	タグ。最大 20 個のタグを指定できます。
Key	string	任意	タグキー。タグキーは空の文字列にすることはできません。タグキーは最大 64 文字の長さにでき、`aliyun` または `acs:` で始めることはできません。 `http://` または `https://` を含めることはできません。最大 20 個のタグキーを指定できます。	tagtest
Value	string	任意	タグ値。タグ値は空にするか、最大 128 文字の文字列にすることができます。 `aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。各タグキーには一意のタグ値が必要です。最大 20 個のタグ値を指定できます。	TagValue

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	レスポンスパラメータ。
TransitRouterId	string	Enterprise Edition トランジットルーターインスタンスの ID。	tr-uf6llz2286805i44g****
RequestId	string	リクエスト ID。	404DA7EC-F495-44B5-B543-6EDCDF90F3D1

例

成功レスポンス

JSONJSON

{
  "TransitRouterId": "tr-uf6llz2286805i44g****",
  "RequestId": "404DA7EC-F495-44B5-B543-6EDCDF90F3D1"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	OperationUnsupported.RegionId	The specified Region is not supported.
400	InstanceExist.TransitRouterInstance	The instance already exists.
400	Forbbiden.TransitRouterServiceNotOpen	The user has not open transit router service.
400	OperationUnsupported.SupportMulticast	The multicast is not supported in the specified region.
400	OperationUnsupported.CenFullLevel	CEN full level does not support TransitRouter.
400	IllegalParam.Cidr	Cidr is illegal.
400	Illegal.TrType	The TransitRouter type is illegal.
400	OperationUnsupported.TransitRouterCidrList	The TransitRouterCidrList is not support in the specified Region.
400	OperationFailed.CidrConflict	Operation is invalid because the cidr conflict.
400	IllegalParam.Region	The specified region is invalid.
400	OverLappingExist.Cidr	The cidr overlapping exist.
400	IllegalParam.ServiceMode	The specified ServiceMode is invalid.
400	ParamExclusive.ServiceModeAndSupportMulticast	ServiceMode and SupportMulticast is mutually exclusive.
400	ParamExclusive.ServiceModeAndTransitRouterCidrList	ServiceMode and TransitRouterCidrList is mutually exclusive.
400	OperationUnsupported.Tag	The Tag is not supported in the specified region.
400	IllegalParam.SupportMulticast	Basic Transit router is not support multicast.
400	ParamExclusive.BasicAndPrimaryStandby	Basic and PrimaryStandby is mutually exclusive.
400	ParamExclusive.BasicAndMultiPrimary	Basic and MultiPrimary is mutually exclusive.
400	IllegalParam.RegionId	The Specified Parameter RegionId is illegal.
400	OperationFailed.PostPay95BwpNotAllowEnterpriseTr	Cbn with post pay 95 bandwidth package does not allow enterprise tr.
400	Forbidden.TransitRouterServiceExpired	The transit router service is out of service.
400	InvalidParameter	Invalid parameter.
400	Unauthorized	The AccessKeyId is unauthorized.

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

変更履歴

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