调用CreateTransitRouterRouteEntry接口在企业版转发路由器的路由表中添加路由条目。

使用说明

CreateTransitRouterRouteEntry接口属于异步接口,即系统会先返回一个路由条目ID,但该路由条目并未创建完成,系统后台的创建任务仍在进行。您可以调用ListTransitRouterRouteEntries接口查询路由条目的状态。

  • 当路由条目处于Creating状态时,表示路由条目正在创建中。在该状态下,您只能对该路由条目执行查询操作,不能执行其他操作。
  • 当路由条目处于Active状态时,表示路由条目创建完成。

调试

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

请求参数

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

系统规定参数。取值:CreateTransitRouterRouteEntry

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

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

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

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

路由条目的名称。

名称长度为0~128个字符,可包含英文字母、数字、中文、半角逗号(,)、半角句号(.)、半角分号(;)、正斜线(/)、at(@)、下划线(_)和短划线(-)。

TransitRouterRouteEntryDescription String testdesc

路由条目的描述。

描述可以为空或描述长度为2~256个字符,可包含英文字母、数字、中文、半角逗号(,)、半角句号(.)、半角分号(;)、正斜线(/)、at(@)、下划线(_)和短划线(-)。

TransitRouterRouteTableId String vtb-bp1dudbh2d5na6b50****

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

TransitRouterRouteEntryNextHopType String BlackHole

下一跳类型。取值:

  • BlackHole:表示指定该路由条目为黑洞路由。所有去往目标网段的路由均会被丢弃,无需指定具体的下一跳信息。
  • Attachment:表示指定该路由条目的下一跳为网络实例连接,且需要指定具体的网络实例连接ID。所有去往目标网段的路由均会被转发至指定的网络实例连接。
TransitRouterRouteEntryDestinationCidrBlock String 192.168.0.0/24

路由条目的目标网段。

TransitRouterRouteEntryNextHopId String tr-attach-nls9fzkfat8934****

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

DryRun Boolean false

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

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

返回数据

名称 类型 示例值 描述
TransitRouterRouteEntryId String rte-75eg4jprkvk0pw****

路由条目ID。

RequestId String 835E7F4B-B380-4E0F-96A5-6EA572388047

请求ID。

示例

请求示例

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

正常返回示例

XML格式

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

<CreateTransitRouterRouteEntryResponse>
    <TransitRouterRouteEntryId>rte-75eg4jprkvk0pw****</TransitRouterRouteEntryId>
    <RequestId>835E7F4B-B380-4E0F-96A5-6EA572388047</RequestId>
</CreateTransitRouterRouteEntryResponse>

JSON格式

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

{
  "TransitRouterRouteEntryId" : "rte-75eg4jprkvk0pw****",
  "RequestId" : "835E7F4B-B380-4E0F-96A5-6EA572388047"
}

错误码

HttpCode 错误码 错误信息 描述
400 DryRunOperation Request validation has been passed with DryRun flag set. DryRun请求验证通过。
400 InvalidTransitRouterRouteTableId.NotFound TransitRouterRouteTableId is not found. 转发路由器路由表实例ID未找到。
400 TransitRouterRouteEntryNextHopId.NotFound TransitRouterRouteEntryNextHopId is not found. 转发路由器路由条目下一跳实例ID不存在。
400 InstanceExist.TransitRouterRouteEntry The instance TransitRouterRouteEntry already exists. 转发路由器路由条目实例已存在。
400 IncorrectStatus.TransitRouterRouteTable TransitRouterRouteTable status is invalid. 转发路由器路由表状态非法。
400 InvalidDestinationCidrBlock.NotFound DestinationCidrBlock is not found. 未找到目标网段。

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