All Products
Search

This Product

    Cloud Enterprise Network:DeleteTransitRouterVpnAttachment

    Document Center

    Cloud Enterprise Network:DeleteTransitRouterVpnAttachment

    Last Updated:Mar 25, 2024

    Deletes a VPN attachment.

    Operation description

    Before you delete a VPN attachment, make sure that the following requirements are met:

    • No associated forwarding correlation is established between the VPN attachment and the route tables of the Enterprise Edition transit router. For more information about how to delete an associated forwarding correlation, see DissociateTransitRouterAttachmentFromRouteTable .
    • No route learning correlation is established between the VPn attachment and the route tables of the Enterprise Edition transit router. For more information about how to delete a route learning correlation, see DisableTransitRouterRouteTablePropagation .
    • No route in the route table of the Enterprise Edition transit router points to the VPN attachment. For more information, see DeleteTransitRouterRouteEntry .

    Debugging

    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
    cen:DeleteTransitRouterVpnAttachmentWrite
    • TransitRouterVpnAttachment
      acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    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 all 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****
    DryRunbooleanNo

    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.
    		false
    TransitRouterAttachmentIdstringYes

    The ID of the VPN attachment.

    		tr-attach-b9xj1dv69600kj****
    ForcebooleanNo

    Specifies whether to forcefully delete the VPN attachment. Valid values:

    • false (default): checks the related resources, such as associated forwarding correlations and route learning policies, before the VPN attachment is deleted. If such a resource exists, the VPN attachment is not deleted and an error message is returned.
    • true: deletes the VPN attachment and the related resources.
    		false

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response.

    RequestIdstring

    The ID of the request.

    		FA43C571-E88B-56C0-8FF8-5646D9B96297

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "FA43C571-E88B-56C0-8FF8-5646D9B96297"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400OperationFailed.RouteTableAssociationExistOperation failed because TransitRouterRouteTable exists.The error message returned because a transit router route table (TransitRouterRouteTable) exists.
    400OperationFailed.RouteEntryExistOperation failed because the TransitRouterAttachment exists in RouteTable.-
    400InvalidTransitRouterAttachmentId.NotFoundThe TransitRouterAttachmentId is not found.The error message returned because the specified transit router attachment ID (TransitRouterAttachmentId) does not exist.
    400OperationFailed.NotSupportForceDeleteNot support force delete attachment.The error message returned because the specified resource cannot be forcefully deleted.
    400OperationUnsupported.TransitRouterTypeThe operation is not supported because of the wrong transitRouter type.The error message returned because this operation is not supported by the specified type of transit router.
    400IncorrectStatus.ResourceStatusThe resource is not in a valid state for the attachment operation.The error message returned because this operation is not supported when the specified resource is in an unstable state. Try again later.
    400OperationFailed.RouteTablePropagationExistOperation failed because You are not allowed to delete TransitAttachment with TransitRouter RouteTable Associated.The error message returned because the transit route attachment (TransitAttachment) is associated with a route table. Disassociate the attachment from the route table and try again.
    400OperationFailed.PrefixListExistOperation failed because PrefixList exists.The error message returned because a prefix list exists.
    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.

    Change history

    Change timeSummary of changesOperation
    2022-12-22The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2022-12-02The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: Force