文档

DeleteTransitRouter - 删除企业版转发路由器实例

更新时间:

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

接口说明

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

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

前提条件

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

调试

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

调试

授权信息

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

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

请求参数

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

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
02fb3da4-130e-11e9-8e44-001****
DryRunboolean

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

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

转发路由器实例 ID。

tr-uf654ttymmljlvh2x****

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

6DE3EE92-39C8-4BBD-A3AD-F568D74741BB

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400OperationFailed.DeleteTransitRouterOperation failed because TransitRouterRouteTable or TransitRouterRouteEntry or BandwidthTransitRegion exists.存在自定义路由,或自定义路由表,或带宽复用配置,无法进行该操作,请删除相应配置后重试。
400IncorrectStatus.TransitRouterInstanceThe status of TransitRouter is incorrect.转发路由器状态不正确。
400OperationFailed.CCNAttachedCan not delete transit router because CCN still attached.存在绑定的CCN,不允许删除转发路由器。
400OperationFailed.BandwidthLimitExistOperation is invalid because a bandwidth limit exist.当前TR还存在已经配置的跨地域带宽,请删除所有跨地域带宽后再删除TR。
400IncorrectStatus.CenInstanceThe status of CenInstance is incorrect.该转发路由器所属CEN当前状态不支持该操作,请等待CEN处于稳态后重试。
400OperationFailed.TrafficMarkingPolicyExistOperation is invalid because traffic marking policy exists.流量标记策略存在,请删除流量标记策略后再删除转发路由器。
400OperationFailed.MulticastDomainExistOperation is invalid because multicast domain exists.组播域存在,请先删除组播域后再删除转发路由器。
400OperationFailed.PrefixListExistOperation is invalid because prefix list exists.prefix list存在,无法支持该操作,请删除prefix list后重试。
400OperationFailed.TrafficQosPolicyExistOperation is invalid because traffic qos policy exists.存在流量调度策略,无法进行该操作,请删除后重试。
400OperationFailed.CloudRouteExistOperation is invalid because cloud route exists.当前TR存在云服务路由配置,请先访问云服务配置页面删除该TR上配置的所有云服务路由。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2022-12-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)
文档反馈