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

UpdateTransitRouterVpcAttachmentAttribute 操作を呼び出して、Enterprise Edition トランジットルーター上の VPC 接続の名前と説明を変更します。この操作を使用して、Enterprise Edition トランジットルーターが VPC にルートを自動的に公開するかどうかを指定することもできます。

操作説明

UpdateTransitRouterVpcAttachmentAttribute は非同期操作です。リクエストを送信すると、システムはリクエスト ID を返しますが、VPC 接続はすぐには変更されません。システムはバックグラウンドで VPC 接続を変更します。ListTransitRouterVpcAttachments 操作を呼び出して、VPC 接続のステータスをクエリできます。

VPC 接続が Modifying 状態の場合、VPC 接続のクエリのみ可能で、他の操作は実行できません。
VPC 接続が Attached 状態の場合、VPC 接続は変更されています。

今すぐお試しください

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

update

*TransitRouterVpcAttachment

acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエストの RequestId を ClientToken として使用します。各リクエストの RequestId は異なります。	02fb3da4-130e-11e9-8e44-001****
TransitRouterAttachmentId	string	必須	VPC 接続の ID。	tr-attach-nls9fzkfat8934****
TransitRouterAttachmentName	string	任意	VPC 接続の名前。名前は、空にするか、1～128 文字の長さにすることができます。名前の先頭に http:// または https:// を使用することはできません。	testname
TransitRouterAttachmentDescription	string	任意	VPC 接続の説明。説明は、空にするか、1～256 文字の長さにすることができます。説明の先頭に http:// または https:// を使用することはできません。	testdesc
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。ドライランは、権限とインスタンスのステータスをチェックします。有効な値: false (デフォルト): 通常のリクエストを送信します。リクエストがチェックに合格すると、VPC 接続の名前と説明が変更されます。 true: チェックリクエストを送信します。システムは、必須パラメーターとリクエストフォーマットをチェックします。リクエストがチェックに失敗した場合、エラーが返されます。リクエストがチェックに合格した場合、対応するリクエスト ID が返されます。VPC 接続の名前と説明は変更されません。	false
TransitRouterVPCAttachmentOptions	object	任意	VPC 接続の機能プロパティ。
	string	任意	VPC 接続の機能プロパティ。 ipv6Support: IPv6 機能を有効にするかどうかを指定します。 enable: IPv6 機能を有効にします。 disable: IPv6 機能を無効にします。説明 VPC 接続で IPv6 機能を有効にする前に、VPC とそれに関連付けられている vSwitch で IPv6 が有効になっていることを確認してください。詳細については、「AllocateVpcIpv6Cidr」および「CreateVSwitchCidrReservation」をご参照ください。	ipv6Support:enable
AutoPublishRouteEnabled	boolean	任意	Enterprise Edition トランジットルーターが VPC にルートを自動的に公開することを許可するかどうかを指定します。 false: いいえ。 true: はい。	true

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	7E61D334-4025-41EF-9145-FC327B35301D

例

成功レスポンス

JSONJSON

{
  "RequestId": "7E61D334-4025-41EF-9145-FC327B35301D"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IncorrectStatus.TransitRouterAttachmentId	TransitRouterAttachmentId status is invalid.
400	InvalidTransitRouterAttachmentId.NotFound	TransitRouterAttachmentId is not found.
400	InvalidOperation.RegionNotSupport	The operation is not supported in this region.
400	InvalidOperation.VpcAutoRoutesPublishInOtherCEN	The operation is not supported because the VPC is already set autoRoutesPublish in other CEN.
400	QuotaExceeded.VpcAutoRoutesPublishPerTransitRouter	The count of VPC instance which set autoRoutesPublish in transitRouter is over limit.
400	InvalidOperation.VpnAssociated	The operation is not supported because the VPC is associated with VPN.
400	IllegalParam.Ipv6Support	Ipv6Support is illegal. Valid Values are [enable, disable].
400	OperationFailed.VSwitchNotFound	The specified vswitch not found.
400	OperationFailed.VSwitchIpv6CidrNotAllocated	The specified vswitch does not have IPv6 address allocated.
400	OperationInvalid.AttachmentReferencedIPv6RouteEntryExisted	Operation is failed because there is at least one route entry(IPv6) which next hop is the specified attachment.
400	OperationInvalid.AttachmentReferencedVpcIPv6RouteEntryExisted	The specified attachment is referenced by vpc route entry(IPv6).
400	OperationInvalid.EniReferencedIPv6RouteEntryExisted	Operation is failed because there is at least one route entry(IPv6) which next hop is network interface that the specified attachment referenced.
400	OperationUnsupported.VpcRoutePropagationSource	The operation on this VPC route propagation source is not supported.
400	OperationUnsupported.TransitRouterType	The specified TransitRouterType does not support the operation.
400	InvalidParameter	Invalid parameter.
400	Unauthorized	The AccessKeyId is unauthorized.
400	INVALID_OPERATION_RESOURCE_NOT_SUPPORT_APPLIANCE_MODE	Only VPC attachment support appliance mode.
400	InvalidParameter.Ipv6Support	The specified parameter Ipv6Support is invalid.
400	InvalidParameter.ApplianceModeSupport	The specified parameter ApplianceModeSupport is invalid.
400	ParamExclusive.TransitRouterVPCAttachmentOptionsAndOptions	When creating or modifying a VPC attachment, the input parameter TransitRouterVPCAttachmentOptions and Options cannot be used at the same time.

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

変更履歴

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