调用DeleteTransitRouter接口删除转发路由器实例。

使用说明

DeleteTransitRouter接口属于异步接口，即系统会先返回一个RequestId，但该转发路由器实例并未删除完成，系统后台的删除任务仍在进行。您可以调用ListTransitRouters接口查询转发路由器实例的状态。

  • 当转发路由器实例处于Deleting状态时，表示转发路由器实例正在删除中，在该状态下，您只能对转发路由器实例执行查询操作，不能执行其他操作。
  • 当查询不到指定的转发路由器实例时，表示转发路由器实例删除完成。

前提条件

删除转发路由器实例前，请确保满足以下条件：

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DeleteTransitRouter

系统规定参数。取值：DeleteTransitRouter。

ClientToken String 否 02fb3da4-130e-11e9-8e44-001****

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

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

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
DryRun Boolean 否 false

是否对此次删除请求执行预检，包括权限、实例状态校验等。取值：

  • false（默认）：发送正常请求，通过检查后直接删除转发路由器实例。
  • true：发送检查请求，只进行校验，不会删除转发路由器实例。检查项包括是否填写了必需参数、请求格式等。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
TransitRouterId String 是 tr-uf654ttymmljlvh2x****

转发路由器实例ID。

返回数据

名称 类型 示例值 描述
RequestId String 6DE3EE92-39C8-4BBD-A3AD-F568D74741BB

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DeleteTransitRouter
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&DryRun=false
&TransitRouterId=tr-uf654ttymmljlvh2x****
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DeleteTransitRouterResponse>
    <RequestId>6DE3EE92-39C8-4BBD-A3AD-F568D74741BB</RequestId>
</DeleteTransitRouterResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "6DE3EE92-39C8-4BBD-A3AD-F568D74741BB"
}

错误码

HttpCode 错误码 错误信息 描述
400 OperationFailed.DeleteTransitRouter Operation failed because TransitRouterRouteEntry exists 有TransitRouterRouteEntry时，无法删除TransitRouter。
400 OperationFailed.DeleteTransitRouter Operation failed because TransitRouterRouteTable exists 有自定义的TransitRouterRouteTable时，无法删除TransitRouter。
400 IncorrectStatus.TransitRouterInstance The status of TransitRouter is incorrect. 转发路由器状态不正确。
400 OperationFailed.BandwidthLimitExist Operation is invalid because a bandwidth limit exist. 由于带宽限速存在，该操作无效。

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