DeleteTransitRouterRouteEntry を呼び出して静的ルートを削除 - CEN - Alibaba Cloud - Cloud Enterprise Network

Enterprise Edition トランジットルーターの転送ルートテーブルから、ブラックホールまたは接続インスタンスタイプの静的ルートエントリを削除します。

操作説明

この操作を呼び出してルートエントリを削除する前に、以下の情報にご注意ください。

ルートエントリを削除するために TransitRouterRouteEntryId を指定する場合、TransitRouterRouteTableId または TransitRouterRouteEntryDestinationCidrBlock を指定する必要はありません。指定すると、パラメーター競合エラーが発生します。
ルートエントリを削除するために TransitRouterRouteEntryId を指定しない場合、ルートエントリのネクストホップタイプに基づいて対応するパラメーターを指定してください。
- ブラックホールルートを削除するには、TransitRouterRouteTableId、TransitRouterRouteEntryDestinationCidrBlock、および TransitRouterRouteEntryNextHopType を指定します。
- 非ブラックホールルートを削除するには、TransitRouterRouteTableId、TransitRouterRouteEntryDestinationCidrBlock、TransitRouterRouteEntryNextHopType、および TransitRouterRouteEntryNextHopId を指定します。
DeleteTransitRouterRouteEntry は非同期操作です。リクエストを送信すると、システムは RequestId を返しますが、ルートエントリはまだ削除されていません。削除タスクはバックグラウンドで実行されます。ListTransitRouterRouteEntries を呼び出して、ルートエントリのステータスをクエリできます。
- ルートエントリが Deleting 状態の場合、そのルートエントリは削除中です。この状態では、ルートエントリのクエリのみが可能で、その他の操作は実行できません。
- ルートエントリが見つからない場合、そのルートエントリは削除済みです。

使用制限

この操作では静的ルートエントリのみを削除できます。自動学習されたルートエントリは削除できません。 ListTransitRouterRouteEntries を呼び出して、ルートエントリのタイプをクエリできます。

今すぐお試しください

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

delete

TransitRouterRouteEntry

acs:cen:*:{#accountId}:centransitrouterroutentry/{#centransitrouterroutentryId}

TransitRouterRouteTable

acs:cen:*:{#accountId}:centransitrouterroutentry/{#transitrouterroutetableId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを使用できます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。RequestId は各 API 呼び出しごとに異なる場合があります。	02fb3da4-130e-11e9-8e44-001****
DryRun	boolean	任意	権限やインスタンスステータスの検証を含むドライランを実行するかどうかを指定します。有効な値: false (デフォルト): 通常のリクエストを送信し、検証に合格した後にルートエントリを直接削除します。 true: チェックリクエストを送信します。検証のみが実行され、ルートエントリは削除されません。システムは必須パラメーター、リクエストフォーマット、その他の条件をチェックします。チェックに失敗した場合、対応するエラーが返されます。チェックに成功した場合、対応するリクエスト ID が返されます。	false
TransitRouterRouteEntryId	string	任意	ルートエントリの ID。	rte-75eg4jprkvk0pw****
TransitRouterRouteEntryNextHopType	string	任意	ルートエントリのネクストホップタイプ。有効な値: BlackHole: ルートエントリはブラックホールルートです。ネクストホップ情報を指定する必要はありません。 Attachment: ルートエントリのネクストホップはネットワークインスタンス接続です。ネクストホップとしてネットワークインスタンス接続の ID も指定する必要があります。	BlackHole
TransitRouterRouteEntryDestinationCidrBlock	string	任意	送信先 CIDR ブロック。	192.168.0.0/24
TransitRouterRouteEntryNextHopId	string	任意	ルートエントリのネクストホップに関連付けられたネットワークインスタンス接続の ID。	tr-attach-nls9fzkfat8934****
TransitRouterRouteTableId	string	任意	Enterprise Edition トランジットルーターのルートテーブルの ID。	vtb-bp1dudbh2d5na6b50****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E

例

成功レスポンス

JSONJSON

{
  "RequestId": "2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	DryRunOperation	Request validation has been passed with DryRun flag set.	DryRun リクエストの検証が有効です。
400	IllegalParam.TransitRouterRouteEntryId	TransitRouterRouteEntryId is not found.	リクエストで指定された TransitRouterRouteEntryId が無効です。
400	ParamExclusive.RouteEntryIdAndRouteTableIdOrDestCidrBlock	RouteEntryId and TransitRouterRouteTableIdOrDestCidrBlock is mutually exclusive.	RouteEntryId、TransitRouterRouteTableId、および DestCidrBlock の各パラメーターは相互排他です。
400	InvalidTransitRouterRouteTableId.NotFound	TransitRouterRouteTableId is not found.	トランジットルーターのルートテーブルインスタンス ID が見つかりませんでした。
400	InvalidDestinationCidrBlock.NotFound	DestinationCidrBlock is not found.	パラメーターで指定された DestinationCidrBlock が存在しません。
400	OperationFailed.DeleteTransitRouterRouteEntry	Operation failed because this route entry is created automatically.	システムによる自動作成のルートエントリは削除できません。
400	IllegalParam.NextHopType	The NextHopType is illegal.	リクエストに指定された NextHopType が無効です。
400	IllegalParam.TransitRouterRouteTableId	The transitRouter route table id is illegal.	リクエストに指定された TransitRouterRouteTableId が無効です。
400	MissingParam.TransitRouterRouteEntryNextHopId	The parameter TransitRouterRouteEntryNextHopId is mandatory	TransitRouterRouteEntryNextHopId パラメーターが不足しています。
400	InvalidParameter	Invalid parameter.	パラメーターが無効です。
400	Unauthorized	The AccessKeyId is unauthorized.	この操作を実行するために必須の権限がアカウントにありません。
400	InvalidParameter.TransitRouterRouteEntryId	The specified parameter TransitRouterRouteEntryId is invalid.	TransitRouterRouteEntryId パラメーターが無効です。
400	InvalidParameter.TransitRouterRouteEntryNextHopId	The specified parameter TransitRouterRouteEntryNextHopId is invalid.	TransitRouterRouteEntryNextHopId パラメーターが無効です。
400	InvalidParameter.TransitRouterRouteTableId	The specified parameter TransitRouterRouteTableId is invalid.

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

変更履歴

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