首页 云企业网 API参考 API目录 转发路由器路由条目 DeleteTransitRouterRouteEntry - 删除企业版转发路由器路由表中静态配置的路由条目

DeleteTransitRouterRouteEntry - 删除企业版转发路由器路由表中静态配置的路由条目

删除企业版转发路由器路由表中静态配置的路由条目。

接口说明

在您调用本接口删除路由条目前,请先了解以下信息:

  • 如果您通过TransitRouterRouteEntryId删除指定的路由条目,则您无需填写TransitRouterRouteTableIdTransitRouterRouteEntryDestinationCidrBlock参数的值,否则会产生参数互斥。

  • 如果您未通过TransitRouterRouteEntryId删除指定的路由条目,则您需依据路由条目的下一跳类型,填写相应参数:

    • 如果您要删除黑洞路由,则您需要填写TransitRouterRouteTableIdTransitRouterRouteEntryDestinationCidrBlockTransitRouterRouteEntryNextHopType参数的值。
    • 如果您要删除非黑洞路由,则您需要填写TransitRouterRouteTableIdTransitRouterRouteEntryDestinationCidrBlockTransitRouterRouteEntryNextHopTypeTransitRouterRouteEntryNextHopId参数的值。
  • DeleteTransitRouterRouteEntry接口属于异步接口,即系统会先返回一个RequestId,但路由条目并未删除完成,系统后台的删除任务仍在进行。您可以调用ListTransitRouterRouteEntries接口查询路由条目的状态。

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

使用限制

本接口只能删除静态配置的路由条目,不支持删除自动学习的路由条目。您可以通过调用ListTransitRouterRouteEntries接口查询路由条目的类型。

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
ClientToken string

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

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

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

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

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

路由条目ID。

rte-75eg4jprkvk0pw****
TransitRouterRouteEntryNextHopType string

下一跳类型。取值:

  • BlackHole:表示该路由条目为黑洞路由,无需指定具体的下一跳信息。
  • Attachment:表示该路由条目的下一跳为网络实例连接,且需要指定下一跳的网络实例连接ID。
BlackHole
TransitRouterRouteEntryDestinationCidrBlock string

目的网段。

192.168.0.0/24
TransitRouterRouteEntryNextHopId string

路由条目的下一跳所关联的网络实例连接ID。

tr-attach-nls9fzkfat8934****
TransitRouterRouteTableId string

企业版转发路由器路由表ID。

vtb-bp1dudbh2d5na6b50****

返回参数

名称 类型 描述 示例值
object
RequestId string

请求ID。

2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E

示例

正常返回示例

JSON格式

{
  "RequestId": "2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E"
}

错误码

Http code 错误码 错误信息 描述
400 DryRunOperation Request validation has been passed with DryRun flag set. DryRun请求验证通过。
400 IllegalParam.TransitRouterRouteEntryId TransitRouterRouteEntryId is not found. 参数中指定的TransitRouterRouteEntryId不合法。
400 ParamExclusive.RouteEntryIdAndRouteTableIdOrDestCidrBlock RouteEntryId and TransitRouterRouteTableIdOrDestCidrBlock is mutually exclusive. RouteEntryId, TransitRouterRouteTableId或DestCidrBlock参数互斥。
400 InvalidTransitRouterRouteTableId.NotFound TransitRouterRouteTableId is not found. 转发路由器路由表实例ID未找到。
400 InvalidDestinationCidrBlock.NotFound DestinationCidrBlock is not found. 参数中指定的DestinationCidrBlock不存在。
400 OperationFailed.DeleteTransitRouterRouteEntry Operation failed because this route entry is created automatically. 系统自动创建的路由不能删除。

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

变更历史

变更时间 变更内容概要 操作
2023-01-04 OpenAPI 错误码发生变更
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    错误码400变更
阿里云首页 云企业网 相关技术圈