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

操作説明

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

トランジットルーターインスタンスが 変更中 状態の場合、インスタンスは変更中です。この状態では、インスタンスのクエリのみ可能です。他の操作は実行できません。
トランジットルーターインスタンスが アクティブ 状態の場合、変更は完了しています。

今すぐお試しください

この 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	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。異なるリクエスト間で値が一意になるように、クライアントトークンを生成します。クライアントトークンには ASCII 文字のみを含めることができます。説明このパラメータを指定しない場合、システムはリクエストの RequestId を ClientToken として自動的に使用します。各リクエストの RequestId は一意です。	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.

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

変更履歴

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