文档

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:DeleteTransitRouterRouteEntryWrite
  • TransitRouterRouteEntry
    acs:cen:*:{#accountId}:centransitrouterroutentry/{#centransitrouterroutentryId}
  • TransitRouterRouteTable
    acs:cen:*:{#accountId}:centransitrouterroutentry/{#transitrouterroutetableId}

请求参数

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

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

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

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

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

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

路由条目 ID。

rte-75eg4jprkvk0pw****
TransitRouterRouteEntryNextHopTypestring

下一跳类型。取值:

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

目的网段。

192.168.0.0/24
TransitRouterRouteEntryNextHopIdstring

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

tr-attach-nls9fzkfat8934****
TransitRouterRouteTableIdstring

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

vtb-bp1dudbh2d5na6b50****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400DryRunOperationRequest validation has been passed with DryRun flag set.DryRun请求验证通过。
400IllegalParam.TransitRouterRouteEntryIdTransitRouterRouteEntryId is not found.参数中指定的TransitRouterRouteEntryId不合法。
400ParamExclusive.RouteEntryIdAndRouteTableIdOrDestCidrBlockRouteEntryId and TransitRouterRouteTableIdOrDestCidrBlock is mutually exclusive.RouteEntryId, TransitRouterRouteTableId或DestCidrBlock参数互斥。
400InvalidTransitRouterRouteTableId.NotFoundTransitRouterRouteTableId is not found.转发路由器路由表实例ID未找到。
400InvalidDestinationCidrBlock.NotFoundDestinationCidrBlock is not found.参数中指定的DestinationCidrBlock不存在。
400OperationFailed.DeleteTransitRouterRouteEntryOperation failed because this route entry is created automatically.系统自动创建的路由不能删除。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2023-10-18OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-01-04OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)