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

使用说明

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

  • 如果您通过TransitRouterRouteEntryId删除指定的路由条目,则您无需填写TransitRouterRouteTableIdTransitRouterRouteEntryDestinationCidrBlock参数的值,否则会产生参数互斥。
  • 如果您未通过TransitRouterRouteEntryId删除指定的路由条目,则您需依据路由条目的下一跳类型,填写相应参数:
    • 如果您要删除黑洞路由,则您需要填写TransitRouterRouteTableIdTransitRouterRouteEntryDestinationCidrBlockTransitRouterRouteEntryNextHopType参数的值。
    • 如果您要删除非黑洞路由,则您需要填写TransitRouterRouteTableIdTransitRouterRouteEntryDestinationCidrBlockTransitRouterRouteEntryNextHopTypeTransitRouterRouteEntryNextHopId参数的值。
  • DeleteTransitRouterRouteEntry接口属于异步接口,即系统会先返回一个RequestId,但路由条目并未删除完成,系统后台的删除任务仍在进行。您可以调用ListTransitRouterRouteEntries接口查询路由条目的状态。
    • 当路由条目处于Deleting状态时,表示路由条目正在删除中。在该状态下,您只能对该路由条目执行查询操作,不能执行其他操作。
    • 当查询不到指定的路由条目时,表示该路由条目删除完成。

使用限制

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

调试

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

请求参数

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

系统规定参数。取值:DeleteTransitRouterRouteEntry

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

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

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

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

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

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

路由条目ID。

TransitRouterRouteEntryNextHopType String BlackHole

下一跳类型。取值:

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

目的网段。

TransitRouterRouteEntryNextHopId String tr-attach-nls9fzkfat8934****

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

TransitRouterRouteTableId String vtb-bp1dudbh2d5na6b50****

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

返回数据

名称 类型 示例值 描述
RequestId String 2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DeleteTransitRouterRouteEntry
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&DryRun=false
&TransitRouterRouteEntryId=rte-75eg4jprkvk0pw****
&TransitRouterRouteEntryNextHopType=BlackHole
&TransitRouterRouteEntryDestinationCidrBlock=192.168.0.0/24
&TransitRouterRouteTableId=vtb-bp1dudbh2d5na6b50****
&公共请求参数

正常返回示例

XML格式

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

<DeleteTransitRouterRouteEntryResponse>
    <RequestId>2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E</RequestId>
</DeleteTransitRouterRouteEntryResponse>

JSON格式

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

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

错误码

HttpCode 错误码 错误信息 描述
400 DryRunOperation Request validation has been passed with DryRun flag set. DryRun请求验证通过。

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