全部产品
Search
文档中心

云企业网:DeleteTransitRouterVpnAttachment - 删除VPN连接

更新时间:Mar 25, 2024

调用DeleteTransitRouterVpnAttachment接口删除VPN连接。

接口说明

在调用 DeleteTransitRouterVpnAttachment 接口过程时请确保输入的参数值无误。如果您输入的参数有误调用接口后仍然会返回 RequestId,但不会删除 VPN 连接。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cen:DeleteTransitRouterVpnAttachmentWrite
  • TransitRouterVpnAttachment
    acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}

请求参数

名称类型必填描述示例值
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-42665544****
DryRunboolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会删除 VPN 连接。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后直接删除 VPN 连接。
false
TransitRouterAttachmentIdstring

VPN 连接 ID。

tr-attach-b9xj1dv69600kj****
Forceboolean

是否强制删除 VPN 连接,取值:

  • false(默认值):删除 VPN 连接前校验是否存在相关资源依赖,如关联转发、路由学习等。如果存在相关依赖,则不允许删除,返回对应错误。
  • true:删除 VPN 连接时,默认删除所有相关依赖。
false

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400OperationFailed.RouteTableAssociationExistOperation failed because TransitRouterRouteTable exists.TransitRouterRouteTable存在,无法支持当前操作。
400OperationFailed.RouteEntryExistOperation failed because the TransitRouterAttachment exists in RouteTable.-
400InvalidTransitRouterAttachmentId.NotFoundThe TransitRouterAttachmentId is not found.参数中指定的TransitRouterAttachmentId不存在。
400OperationFailed.NotSupportForceDeleteNot support force delete attachment.不支持强制删除功能。
400OperationUnsupported.TransitRouterTypeThe operation is not supported because of the wrong transitRouter type.当前TransitRouter类型不支持该操作。
400IncorrectStatus.ResourceStatusThe resource is not in a valid state for the attachment operation.该资源不处于稳态,无法进行该操作,请稍后重试。
400OperationFailed.RouteTablePropagationExistOperation failed because You are not allowed to delete TransitAttachment with TransitRouter RouteTable Associated.TransitAttachment绑定在路由表上,请解绑后重试。
400OperationFailed.PrefixListExistOperation failed because PrefixList exists.prefixlist存在,操作失败。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-12-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2022-12-02OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:Force