Call UpdateTransitRouterVpnAttachmentAttribute to modify VPN attachment attributes - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Invokes the UpdateTransitRouterVpnAttachmentAttribute operation to modify the name, description, and whether to automatically publish route entries for a VPN connection under an Enterprise Edition transit router.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:UpdateTransitRouterVpnAttachmentAttribute

update

*TransitRouterVpnAttachment

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

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 client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	123e4567-e89b-12d3-a456-42665544****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run without modifying the VPN connection configurations. The system checks whether the required parameters are specified, whether the request format is valid, and whether the business restrictions are met. If the check fails, the corresponding error is returned. If the check succeeds, the error code `DryRunOperation` is returned. false (default): performs a dry run and then modifies the VPN connection configurations after the check succeeds.	false
TransitRouterAttachmentId	string	Yes	The VPN connection ID.	tr-attach-a6p8voaodog5c0****
TransitRouterAttachmentName	string	No	The new 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 forward routing instance to automatically publish route entry to the IPsec connection. Valid values: true: allowed. false: not allowed.	true
OrderType	string	No	The payer of the network instance. Valid values: PayByCenOwner: The connection fee and data processing fee of the VPN connection are paid by the account that owns the transit router instance. PayByResourceOwner: The connection fee and data processing fee of the VPN connection are paid by the account that owns the VPN gateway instance. Valid values: PayByResourceOwner : The account that owns the network instance pays the fees. PayByCenOwner : The account that owns the Cloud Enterprise Network (CEN) instance pays the fees.	PayByCenOwner

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1AB038F2-96E5-560B-9F6E-734311D466FA

Examples

Success response

JSON format

{
  "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.
400	InvalidParameter.OrderType	The specified parameter OrderType is invalid.	The specified parameter OrderType is invalid.
400	InvalidOperation.OrderTypeMustMatchGrantCrossAccount	The OrderType must be the same as the OrderType in the grant cross-account record.	The OrderType must be the same as the OrderType in the grant cross-account record.
400	OperationFailed.GrantCrossAccountNotExist	Cross-account authorization does not exist.	Cross-account authorization does not exist.
400	InvalidParameter.CenBandwidthPackageId	The specified parameter CenBandwidthPackageId is invalid.	The parameter CenBandwidthPackageId entered is illegal.
400	InvalidParameter.TransitRouterAttachmentId	The specified parameter TransitRouterAttachmentId is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.