UpdateTransitRouter を使用して TransitRouter の名前と説明を変更 - CEN - Alibaba Cloud - Cloud Enterprise Network

トランジットルーターインスタンスの名前と説明を変更します。

操作説明

UpdateTransitRouter は非同期操作です。リクエストを送信すると、システムは RequestId を返しますが、トランジットルーターインスタンスの変更はまだ完了していません。変更タスクはバックグラウンドで実行され続けます。ListTransitRouters 操作を呼び出して、トランジットルーターインスタンスのステータスをクエリできます。

トランジットルーターインスタンスが Modifying 状態の場合、トランジットルーターインスタンスは変更中です。この状態では、トランジットルーターインスタンスのクエリのみ可能です。他の操作は実行できません。
トランジットルーターインスタンスが 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:UpdateTransitRouter

update

*TransitRouter。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。ClientToken 値には ASCII 文字のみを使用できます。説明このパラメーターを指定しない場合、システムは RequestId を ClientToken として使用します。RequestId は API リクエストごとに異なる場合があります。	02fb3da4-130e-11e9-8e44-001****
DryRun	boolean	任意	権限とインスタンスステータスのチェックを含む、この変更リクエストのドライランを実行するかどうかを指定します。有効な値: false (デフォルト): 通常のリクエストを送信します。リクエストがチェックに合格すると、トランジットルーターインスタンス情報は直接変更済みとなります。 true: チェックリクエストを送信します。検証のみが実行され、トランジットルーターインスタンス情報は変更済みにはなりません。チェック項目には、必須パラメーターが指定されているかどうか、およびリクエストフォーマットが含まれます。チェックに失敗した場合、対応するエラーが返されます。チェックに合格した場合、対応するリクエスト ID が返されます。	false
RegionId	string	必須	トランジットルーターインスタンスのリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。	cn-shanghai
TransitRouterId	string	必須	トランジットルーターインスタンスの ID。	tr-uf654ttymmljlvh2x****
TransitRouterName	string	任意	トランジットルーターインスタンスの新しい名前。名前は空、または 1～128 文字の長さにできます。http:// または https:// で始めることはできません。	testname
TransitRouterDescription	string	任意	トランジットルーターインスタンスの新しい説明。説明は空、または 1～256 文字の長さにできます。http:// または https:// で始めることはできません。	testdesc

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	E9963DD7-998B-4F92-892D-8293CB49EE81

例

成功レスポンス

JSONJSON

{
  "RequestId": "E9963DD7-998B-4F92-892D-8293CB49EE81"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	OperationUnsupported.RegionId	The specified region ID is not supported.	現在のリージョンでは、この操作はサポートされていません。
400	IncorrectStatus.TransitRouterInstance	The status of TransitRouter is incorrect.	トランジットルーターが無効な状態です。
400	InvalidParameter	Invalid parameter.	パラメーターが無効です。
400	Unauthorized	The AccessKeyId is unauthorized.	この操作を実行するための十分な権限がありません。チケットを起票してサポートにお問い合わせください。
400	OperationFailed.ZoneNotSupportJumbo	The following zones do not support Jumbo Frame: %s.	ジャンボフレームの有効化に失敗しました。現在のトランジットルーターが使用しているゾーン %s はジャンボフレームをサポートしていません。
400	OperationFailed.TransitRouterNotSupportJumbo	This transit router does not support Jumbo Frame in available zones: %s. Please contact Alibaba Cloud support for assistance.	トランジットルーターは、ゾーン %s のジャンボフレームをサポートしていません。サポートが必要な場合は、Alibaba Cloud にお問い合わせください。
400	ParamExclusive.SupportJumboFrameAndSupportMulticast	Transit Router can not support JumboFrame and Multicast at the same time.	トランジットルーターは、ジャンボフレーム機能とマルチキャスト機能を同時に有効にすることをサポートしていません。
400	OperationUnsupported.MulticastAndJumboFrameAreExclusive	The operation is not supported because the multicast and jumbo frame are exclusive.	トランジットルーターでは、マルチキャスト機能とジャンボフレーム機能を同時に有効にすることはできません。
400	OperationUnsupported.SupportJumboFrame	JumboFrame is unsupported.	ジャンボフレーム機能はサポートされていません。
400	OperationUnsupported.DisableJumboFrame	Disable JumboFrame is not supported.	トランジットルーターでのジャンボフレームの特徴の無効化はサポートされていません。
400	InvalidParameter.TransitRouterId	The specified parameter TransitRouterId is invalid.	指定された TransitRouterId パラメーターは無効です。
400	OperationUnsupported.TransitRouterType	The operation is not supported because of the wrong transitRouter type.	現在のトランジットルーターのタイプでは、この操作はサポートされていません。
404	Instance.NotExist	The instance is not exist.	指定されたインスタンスは存在しません。

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

変更履歴

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