すべてのプロダクト
Search
ドキュメントセンター

Cloud Enterprise Network:UpdateTransitRouterVpnAttachmentAttribute

最終更新日:Mar 25, 2026

Enterprise Edition トランジットルーターにアタッチされた VPN 接続の属性を変更します。接続名、説明文、および自動ルート配信設定を変更できます。

今すぐお試しください

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

update

*TransitRouterVpnAttachment

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

ClientToken

string

任意

リクエストのべき等性を保証するためのクライアントトークンです。

クライアント側でトークンを生成できますが、異なるリクエスト間で一意である必要があります。トークンには ASCII 文字のみを使用できます。

説明

このパラメーターを指定しない場合、システムは自動的にリクエストの RequestIdClientToken として使用します。RequestId はリクエストごとに異なる可能性があります。

123e4567-e89b-12d3-a456-42665544****

DryRun

boolean

任意

ドライラン実行の有無を指定します。有効な値は以下のとおりです。

  • true:VPN 接続の属性を変更せずにリクエストの妥当性を確認するドライランを実行します。システムは必須パラメーター、リクエストフォーマット、およびサービス制限をチェックします。チェックに失敗した場合はエラーメッセージが返され、成功した場合は DryRunOperation エラーコードが返されます。

  • false(デフォルト):通常のリクエストを送信します。チェックに合格した場合、システムは VPN 接続の属性を変更します。

false

TransitRouterAttachmentId

string

必須

VPN 接続の ID です。

tr-attach-a6p8voaodog5c0****

TransitRouterAttachmentName

string

任意

VPN 接続の新しい名称です。

空欄でも構いませんが、長さは 1~128 文字で、http:// または https:// で始めてはいけません。

nametest

TransitRouterAttachmentDescription

string

任意

VPN 接続の新しい説明文です。

空欄でも構いませんが、長さは 1~256 文字で、http:// または https:// で始めてはいけません。

desctest

AutoPublishRouteEnabled

boolean

任意

Enterprise Edition トランジットルーターが IPsec 接続に対してルートを自動的に配信することを許可するかどうかを指定します。有効な値は以下のとおりです。

  • true:Enterprise Edition トランジットルーターが IPsec 接続に対してルートを自動的に配信します。

  • false:Enterprise Edition トランジットルーターが IPsec 接続に対してルートを自動的に配信しません。

true

レスポンスフィールド

フィールド

説明

object

応答内容です。

RequestId

string

リクエスト ID です。

1AB038F2-96E5-560B-9F6E-734311D466FA

成功レスポンス

JSONJSON

{
  "RequestId": "1AB038F2-96E5-560B-9F6E-734311D466FA"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidTransitRouterAttachmentId.NotFound TransitRouterAttachmentId is not found.
400 IncorrectStatus.TransitRouterAttachmentId The resource is not in a valid state for the attachment operation.
400 InvalidParameter Invalid parameter.
400 Unauthorized The AccessKeyId is unauthorized.
400 InvalidParameter.OrderType The specified parameter OrderType is invalid.
400 InvalidOperation.OrderTypeMustMatchGrantCrossAccount The OrderType must be the same as the OrderType in the grant cross-account record.
400 OperationFailed.GrantCrossAccountNotExist Cross-account authorization does not exist.

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

変更履歴

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