Docs

Transit Router

VPN attachment

DeleteTransitRouterVpnAttachment - Delete VPN attachment

Call DeleteTransitRouterVpnAttachment to delete the specified Virtual Private Network (VPN) attachment.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.

Action String required Example value: DeleteTransitRouterVpnAttachment

The interface name. The current API name is DeleteTransitRouterVpnAttachment.

Version String required Example value: 2020-04-01

The interface version. The current API version is 2020-04-01.

TransitRouterAttachmentId String required Example: tr-attach-13n2l4c****

The ID of the network instance attachment. You can call the DescribeTransitRouterVpnAttachments API to obtain the ID of the Virtual Private Network (VPN) attachment.

Force Boolean required Example value: false

Describe whether to force delete the VPN attachment.

true: Force delete.

false: Not force delete.

Response parameters

This API does not have specific response parameters. For more information, see Response structure.

Request examples

GET /?Action=DeleteTransitRouterVpnAttachment&Version=2020-04-01&TransitRouterAttachmentId=tr-attach-13n2l4c**** HTTP/1.1​
Host: transitrouter.cn-beijing.volcengineapi.com​
X-Date: 20250804T034303Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250804/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​

Response examples

{​
    "ResponseMetadata": {​
        "RequestId": "20250804114307088173239187B52DB8",​
        "Action": "DeleteTransitRouterVpnAttachment",​
        "Version": "2020-04-01",​
        "Service": "transitrouter",​
        "Region": "cn-beijing"​
    },​
    "Result": {}​
}​

Error codes

The table below describes the error codes for this API that are associated with business logic. For more information, see Common error codes.

Status code	Error codes	Error message	Explanation
400	InvalidTransitRouter.InvalidStatus	The specified Transit Router is not in the correct status for the request.	The specified Transit Router (TR) is in a status that cannot respond to the request.
400	InvalidTransitRouterAttachment.InvalidStatus	The specified Transit Router Attachment is not in the correct status for the request.	The specified network instance attachment is in a status that cannot respond to the request.
400	InvalidTransitRouterAttachment.WithAssociation	The specified Transit Router has route table associations depending on the attachment.	Cannot delete the specified attachment because it contains an association forwarding route table.
400	InvalidTransitRouterAttachment.WithRouteTablePropagation	The specified Transit Router has route table propagations depending on the attachment.	The specified network instance attachment has route learning configured and cannot be deleted.
400	InvalidTransitRouterAttachment.WithStaticRouteEntry	The specified Transit Router has static route entries depending on the attachment.	The specified network instance attachment has static routes configured and cannot be deleted.
403	Forbidden.NoPermissionToOperate	You are not authorized to operate the specified resource.	No permission to manage the specified resource.
404	InvalidTransitRouterAttachment.NotFound	The specified Transit Router attachment does not exist.	The specified network instance attachment does not exist.

Last updated: 2025.12.29 19:35:42