All Products
Document Center

Cloud Enterprise Network:UpdateTransitRouterVpnAttachmentAttribute

Last Updated:Apr 26, 2024

Modifies the configuration of a VPN attachment.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
  • TransitRouterVpnAttachment

Request parameters


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

You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token 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 for each API request may be different.

Specifies whether to perform a dry run. Valid values:

  • true:performs a dry run. The system checks the required parameters, request syntax, and limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
  • false (default): performs a dry run and sends the request.

The ID of the VPN attachment.


The name of the VPN attachment.

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


The new description of the VPN attachment.

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


Specifies whether to allow the transit router to automatically advertise routes to the IPsec-VPN attachment. Valid values:

  • true: yes
  • false: no

Response parameters


The result of the request.


The ID of the request.



Sample success responses


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

Error codes

HTTP status codeError codeError messageDescription
400InvalidTransitRouterAttachmentId.NotFoundTransitRouterAttachmentId is not found.The error message returned because the ID of the network instance does not exist.
400IncorrectStatus.TransitRouterAttachmentIdThe resource is not in a valid state for the attachment operation.The error message returned because the operation is not supported when the specified attachment is in an unstable state
400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
400UnauthorizedThe AccessKeyId is unauthorized.The error message returned because you do not have the permissions to perform this operation.

For a list of error codes, visit the Service error codes.