Modifies the name and description, and enables or disables automatic route advertisement for a VPN connection on an Enterprise Edition transit router.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| cen:UpdateTransitRouterVpnAttachmentAttribute | Read |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClientToken | string | No | 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.
| 123e4567-e89b-12d3-a456-42665544**** |
| DryRun | boolean | No | Specifies whether to perform a dry run. Valid values:
| false |
| TransitRouterAttachmentId | string | Yes | The ID of the VPN attachment. | tr-attach-a6p8voaodog5c0**** |
| TransitRouterAttachmentName | string | No | The name of the VPN connection. The name can be empty or 1 to 128 characters in length, and cannot start with http:// or https://. | nametest |
| TransitRouterAttachmentDescription | string | No | The new description of the VPN connection. The description can be empty or 1 to 256 characters in length, and cannot start with http:// or https://. | desctest |
| AutoPublishRouteEnabled | boolean | No | Specifies whether to allow the transit router to automatically advertise routes to the IPsec-VPN attachment. Valid values:
| true |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "1AB038F2-96E5-560B-9F6E-734311D466FA"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidTransitRouterAttachmentId.NotFound | TransitRouterAttachmentId is not found. | The error message returned because the ID of the network instance does not exist. |
| 400 | IncorrectStatus.TransitRouterAttachmentId | The 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 |
| 400 | InvalidParameter | Invalid parameter. | The error message returned because the parameter is set to an invalid value. |
| 400 | Unauthorized | The 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.