Modifies the configurations of a VPN connection.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateTransitRouterVpnAttachmentAttribute

The operation that you want to perform. Set the value to UpdateTransitRouterVpnAttachmentAttribute.

ClientToken String No 123e4567-e89b-12d3-a456-42665544****

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. ClientToken can contain only ASCII characters.

Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId may be different for each API request.
DryRun Boolean No false

Specifies whether only to precheck the request. Valid values:

  • true: prechecks the request but does not modify the configurations. The system checks the required parameters, request syntax, and limits. If the request fails the precheck, an error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
  • false (default): checks the request. If the request passes the check, the configurations are modified.
TransitRouterAttachmentId String Yes tr-attach-a6p8voaodog5c0****

The ID of the VPN connection.

TransitRouterAttachmentName String No nametest

The name of the VPN connection.

The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter.

TransitRouterAttachmentDescription String No desctest

The new description of the VPN connection.

The description must be 2 to 256 characters in length. The description must start with a letter but cannot start with http:// or https://.

AutoPublishRouteEnabled Boolean No true

Specifies whether to allow the transit router to automatically advertise routes to the IPsec connection. Valid values:

  • true: yes
  • false: no

Response parameters

Parameter Type Example Description
RequestId String 1AB038F2-96E5-560B-9F6E-734311D466FA

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateTransitRouterVpnAttachmentAttribute
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&DryRun=false
&TransitRouterAttachmentId=tr-attach-a6p8voaodog5c0****
&TransitRouterAttachmentName=nametest
&TransitRouterAttachmentDescription=desctest
&AutoPublishRouteEnabled=true
&<Common request parameters>

Sample success responses

XML format 

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

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

JSON format 

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

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

Error codes

HttpCode Error code Error message Description
400 InvalidTransitRouterAttachmentId.NotFound TransitRouterAttachmentId is not found. The error message returned because the ID of the network connection does not exist.

For a list of error codes, visit the Error Center.