VPN接続の設定を変更します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 UpdateTransitRouterVpnAttachmentAttribute

実行する操作です。 値をUpdateTransitRouterVpnAttachmentAttributeに設定します。

ClientToken String 任意 123e4567-e89b-12d3-a456-42665544 ****

リクエストのべき等性を保証するために使用されるクライアントトークン。

クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 ClientTokenにはASCII文字のみを含めることができます。

説明 このパラメーターを設定しない場合、ClientTokenはRequestIdの値に設定されます。 RequestIdの値は、APIリクエストごとに異なる場合があります。
DryRun Boolean 任意 false

リクエストのみを事前チェックするかどうかを指定します。 設定可能な値は以下のとおりです。

  • true: リクエストを事前にチェックしますが、設定は変更しません。 システムは、必要なパラメーター、要求構文、および制限をチェックします。 リクエストが事前チェックに失敗した場合、エラーメッセージが返されます。 リクエストが事前チェックに合格した場合、DryRunOperationエラーコードが返されます。
  • false (デフォルト): リクエストを確認します。 リクエストがチェックに合格すると、設定が変更されます。
TransitRouterAttachmentId String 必須 tr-attach-a6p8voaodog5c0 ****

VPN接続のID。

TransitRouterAttachmentName String 任意 nametest

VPN接続の名前。

名前は2 ~ 128文字で、英数字、アンダースコア (_) 、ハイフン (-) を使用できます。 先頭は文字である必要があります。

TransitRouterAttachmentDescription String 任意 desktest

VPN接続の新しい説明。

説明の長さは 2～256 文字である必要があります。 説明は文字で始める必要がありますが、http:// またはhttps:// で始めることはできません。

AutoPublishRouteEnabled Boolean 任意 真実

トランジットルーターがIPsec接続へのルートを自動的に通知できるようにするかどうかを指定します。 設定可能な値は以下のとおりです。

  • true: はい
  • false: いいえ

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String 1AB038F2-96E5-560B-9F6E-734311D466FA

リクエストの ID です。

例

リクエストの例

http(s)://[Endpoint]/?Action=UpdateTransitRouterVpnAttachmentAttribute
&ClientToken=123e4567-e89b-12d3-a456-42665544 ****
&DryRun=false
&TransitRouterAttachmentId=tr-attach-a6p8voaodog5c0 ****
&TransitRouterAttachmentName=nametest
&TransitRouterAttachmentDescription=desktest
&AutoPublishRouteEnabled=true
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateTransitRouterVpnAttachmentAttributeResponse>
    <RequestId>1AB038F2-96E5-560B-9F6E-734311D466FA</RequestId>
</UpdateTransitRouterVpnAttachmentAttributeResponse>

JSON 形式 

HTTP/1.1 200 OK
Content-Type:application/json

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

エラーコード

HttpCode エラーコード エラーメッセージ 説明
400 InvalidTransitRouterAttachmentId.NotFound TransitRouterAttachmentIdが見つかりません。 ネットワーク接続のIDが存在しない場合に返されるエラーメッセージ。

エラーコードのリストについては、エラーセンターをご覧ください。