CreateTransitRouterRouteEntry - - Alibaba Cloud ドキュメントセンター

Enterprise Edition トランジットルーターのルートテーブルにルートエントリを作成します。

操作説明

CreateTransitRouterRouteEntry は非同期操作です。リクエストを送信すると、システムはルートエントリ ID を返します。ルートエントリはバックグラウンドで作成されます。 ListTransitRouterRouteEntries 操作を呼び出して、ルートエントリのステータスをクエリできます。

ルートエントリが Creating 状態の場合、ルートエントリは作成中です。この状態では、ルートエントリをクエリすることのみが可能で、他の操作は実行できません。
ルートエントリが Active 状態の場合、ルートエントリは作成済みです。

今すぐお試しください

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

create

*TransitRouterRouteTable

acs:cen:*:{#accountId}:centransitrouterroutetable/{#centransitrouterroutetableId}

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。トークンの生成にはクライアントを使用できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムはリクエストの RequestId を ClientToken として自動的に使用します。各 API リクエストの RequestId は異なる場合があります。	02fb3da4-130e-11e9-8e44-001****
TransitRouterRouteEntryName	string	任意	ルートエントリの名前。名前は空にすることも、1 ～ 128 文字の長さにすることもできます。また、http:// または https:// で始めることはできません。	testname
TransitRouterRouteEntryDescription	string	任意	ルートエントリの説明。説明は空にすることも、1 ～ 256 文字の長さにすることもできます。また、http:// または https:// で始めることはできません。	testdesc
TransitRouterRouteTableId	string	必須	Enterprise Edition トランジットルーターのルートテーブルの ID。	vtb-bp1dudbh2d5na6b50****
TransitRouterRouteEntryNextHopType	string	必須	ネクストホップタイプ。有効な値： BlackHole: ルートはブラックホールルートです。宛先 CIDR ブロックへのすべてのパケットは破棄されます。ネクストホップを指定する必要はありません。 Attachment: ルートのネクストホップはネットワークインスタンス接続です。ネットワークインスタンス接続の ID を指定する必要があります。宛先 CIDR ブロックへのすべてのパケットは、指定されたネットワークインスタンス接続に転送されます。	BlackHole
TransitRouterRouteEntryDestinationCidrBlock	string	必須	ルートエントリの宛先 CIDR ブロック。IPv4 および IPv6 CIDR ブロックがサポートされています。	192.168.0.0/24
TransitRouterRouteEntryNextHopId	string	任意	ネクストホップに関連付けられているネットワークインスタンス接続の ID。	tr-attach-nls9fzkfat8934****
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値： false (デフォルト): 通常のリクエストを送信します。リクエストがチェックに合格すると、ルートエントリが作成されます。 true: リクエストをチェックするためにドライランリクエストを送信します。ルートエントリは作成されません。システムは必須パラメーター、リクエストフォーマット、サービス制限をチェックします。リクエストがチェックに失敗した場合、エラーメッセージが返されます。リクエストがチェックに合格した場合、`DryRunOperation` エラーコードが返されます。	false

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object
TransitRouterRouteEntryId	string	ルートエントリの ID。	rte-75eg4jprkvk0pw****
RequestId	string	リクエスト ID。	835E7F4B-B380-4E0F-96A5-6EA572388047

例

成功レスポンス

JSONJSON

{
  "TransitRouterRouteEntryId": "rte-75eg4jprkvk0pw****",
  "RequestId": "835E7F4B-B380-4E0F-96A5-6EA572388047"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	DryRunOperation	Request validation has been passed with DryRun flag set.
400	InvalidTransitRouterRouteTableId.NotFound	TransitRouterRouteTableId is not found.
400	TransitRouterRouteEntryNextHopId.NotFound	TransitRouterRouteEntryNextHopId is not found.
400	OperationFailed.CreateRouteEntryWithCCNAttachment	Operation failed because Create RouteEntry to CCN Attachment does not support.
400	QuotaExceeded.TransitRouterRoutEntry	TransitRouterRoutEntry quota exceeded.
400	IllegalParam.TransitRouterDestinationCidrBlock	TransitRouterDestinationCidrBlock is illegal.
400	InstanceExist.TransitRouterRouteEntry	The instance TransitRouterRouteEntry already exists.
400	IncorrectStatus.TransitRouterRouteTable	TransitRouterRouteTable status is invalid.
400	ParamExclusive.RouteEntryIdAndRouteTableIdOrDestCidrBlock	RouteEntryId and TransitRouterRouteTableIdOrDestCidrBlock is mutually exclusive.
400	InvalidDescription	Description is invalid.
400	InvalidName	Name is invalid.
400	IllegalParam.NextHopType	The NextHopType is illegal.
400	MissingParam.TransitRouterRouteEntryNextHopId	The parameter TransitRouterRouteEntryNextHopId is mandatory
400	InvalidTransitRouterRouteEntryNextHopId.NotFound	TransitRouterRouteEntryNextHopId is not found
400	OperationFailed.CreateRouteEntryWithSameDestinationCidrBlock	Operation failed because Create RouteEntry with same destination cidrblock does not support.
400	InvalidDestinationCidrBlock.NotFound	DestinationCidrBlock is not found.
400	OperationFailed.CreateRouteEntryWithConnectAttachment	Operation failed because Create RouteEntry to connect Attachment does not support.
400	ParamExclusive.NextHopTypeBlackHoleAndNextHopId	TransitRouterRouteEntryNextHopType(BlackHole) and TransitRouterRouteEntryNextHopId is mutually exclusive.
400	InvalidTransitRouterMode.NeedUpgrade	TransitRouter need to upgrade.
400	OperationFailed.CreateTransitRouterRouteEntryWithVPCAttachment	The specified VPC Attachment has not enable IPv6.
400	OperationFailed.CreateTransitRouterRouteEntryWithVPNAttachment	Create RouteEntry to VPN Attachment does not support IPv6.
400	NotSupport.AttachmentRoute	Not support such attachment route.
400	InvalidParameter	Invalid parameter.
400	Unauthorized	The AccessKeyId is unauthorized.

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

変更履歴

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