CreateTransitRouterRouteEntry - 在企业版转发路由器的路由表中添加路由条目

在企业版转发路由器的路由表中添加路由条目。

接口说明

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

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

  • 当路由条目处于 Active 状态时,表示路由条目创建完成。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cen:CreateTransitRouterRouteEntry

create

*TransitRouterRouteTable

acs:cen:*:{#accountId}:centransitrouterroutetable/{#centransitrouterroutetableId}

请求参数

名称

类型

必填

描述

示例值

ClientToken

string

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

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

说明

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

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

TransitRouterRouteEntryName

string

路由条目的名称。

名称可以为空或长度为 1~128 个字符,不能以 http://或 https://开头。

testname

TransitRouterRouteEntryDescription

string

路由条目的描述。

描述可以为空或长度为 1~256 个字符,不能以 http://或 https://开头。

testdesc

TransitRouterRouteTableId

string

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

vtb-bp1dudbh2d5na6b50****

TransitRouterRouteEntryNextHopType

string

下一跳类型。取值:

  • BlackHole:表示指定该路由条目为黑洞路由。所有去往目标网段的路由均会被丢弃,无需指定具体的下一跳信息。

  • Attachment:表示指定该路由条目的下一跳为网络实例连接,且需要指定具体的网络实例连接 ID。所有去往目标网段的路由均会被转发至指定的网络实例连接。

BlackHole

TransitRouterRouteEntryDestinationCidrBlock

string

路由条目的目标网段,支持 IPv4 地址和 IPv6 地址。

192.168.0.0/24

TransitRouterRouteEntryNextHopId

string

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

tr-attach-nls9fzkfat8934****

DryRun

boolean

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

  • false(默认):发送正常请求,通过检查后直接创建路由条目。

  • true:发送检查请求,只进行校验,不会创建路由条目。检查项包括是否填写了必需参数、请求格式等。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation

false

返回参数

名称

类型

描述

示例值

object

TransitRouterRouteEntryId

string

路由条目 ID。

rte-75eg4jprkvk0pw****

RequestId

string

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

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 OperationFailed.CreateRouteEntryWithCCNAttachment Operation failed because Create RouteEntry to CCN Attachment does not support. 不支持创建指向CCN attachment的路由。
400 QuotaExceeded.TransitRouterRoutEntry TransitRouterRoutEntry quota exceeded. 路由数量已达到上限。
400 IllegalParam.TransitRouterDestinationCidrBlock TransitRouterDestinationCidrBlock is illegal. 参数中指定的TransitRouterDestinationCidrBlock不合法。
400 InstanceExist.TransitRouterRouteEntry The instance TransitRouterRouteEntry already exists. 转发路由器路由条目实例已存在。
400 IncorrectStatus.TransitRouterRouteTable TransitRouterRouteTable status is invalid. 转发路由器路由表状态非法。
400 ParamExclusive.RouteEntryIdAndRouteTableIdOrDestCidrBlock RouteEntryId and TransitRouterRouteTableIdOrDestCidrBlock is mutually exclusive. RouteEntryId, TransitRouterRouteTableIdDestCidrBlock参数互斥。
400 InvalidDescription Description is invalid. 描述不合法。
400 InvalidName Name is invalid. name不合法。
400 IllegalParam.NextHopType The NextHopType is illegal. 参数中指定的NextHopType不合法。
400 MissingParam.TransitRouterRouteEntryNextHopId The parameter TransitRouterRouteEntryNextHopId is mandatory 缺少参数TransitRouterRouteEntryNextHopId。
400 InvalidTransitRouterRouteEntryNextHopId.NotFound TransitRouterRouteEntryNextHopId is not found TransitRouterRouteEntryNextHopId不存在。
400 OperationFailed.CreateRouteEntryWithSameDestinationCidrBlock Operation failed because Create RouteEntry with same destination cidrblock does not support. 不允许创建目的网段相同的路由表项。
400 InvalidDestinationCidrBlock.NotFound DestinationCidrBlock is not found. 参数中指定的DestinationCidrBlock不存在。
400 OperationFailed.CreateRouteEntryWithConnectAttachment Operation failed because Create RouteEntry to connect Attachment does not support. 不支持创建指向connect attachment的路由。
400 ParamExclusive.NextHopTypeBlackHoleAndNextHopId TransitRouterRouteEntryNextHopType(BlackHole) and TransitRouterRouteEntryNextHopId is mutually exclusive. 当路由条目中“是否为黑洞路由”勾选“是”时,请不要指定“下一跳连接”。
400 InvalidTransitRouterMode.NeedUpgrade TransitRouter need to upgrade. 当前转发路由器模式不支持。
400 OperationFailed.CreateTransitRouterRouteEntryWithVPCAttachment The specified VPC Attachment has not enable IPv6. 指定的VPC Attachment未使能IPv6.
400 OperationFailed.CreateTransitRouterRouteEntryWithVPNAttachment Create RouteEntry to VPN Attachment does not support IPv6. 不支持创建指向VPN AttachmentIPv6路由条目,请确认后再进行操作。
400 NotSupport.AttachmentRoute Not support such attachment route. 不支持这种连接路由。
400 InvalidParameter Invalid parameter. 参数不合法。
400 Unauthorized The AccessKeyId is unauthorized. 账号无权限操作。

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

变更历史

更多信息,参考变更详情