全部产品
Search
文档中心

云企业网:CreateTransitRouterRouteTable - 为企业版转发路由器创建自定义路由表

更新时间:Jan 17, 2023

为企业版转发路由器创建自定义路由表。

接口说明

  • 当前仅企业版转发路由器支持创建自定义路由表。关于企业版转发路由器支持的地域和可用区信息,请参见什么是云企业网

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

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

调试

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

调试

授权信息

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

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

请求参数

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

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

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

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

自定义路由表名称。

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

testname
TransitRouterRouteTableDescription string

自定义路由表的描述信息。

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

testdesc
TransitRouterId string

企业版转发路由器实例ID。

tr-bp1su1ytdxtataupl****
DryRun boolean

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

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

标签信息。

一次最多支持输入20个标签信息。

object
Key string

资源的标签键。

一旦传入该值,则不允许为空字符串。最多支持64个字符,不能以aliyun或者acs:开头,不能包含http://或者https://

一次最多支持输入20个标签的标签键。

test
Value string

资源的标签值。

标签值可以为空或输入不超过128个字符的字符串,不能以aliyun或者acs:开头,不能包含http://或者https://

每一个标签键对应一个标签值,一次最多支持输入20个标签键对应的标签值。

tagtest
RouteTableOptions object

路由表功能选项。

MultiRegionECMP string

多地域等价路由,取值:

  • disable(默认):关闭多地域等价路由。关闭多地域等价路由后,从不同地域学到的相同前缀的路由在其他路由属性一致的情况下将会优选Region ID最小的TR作为下一跳(按字母排序),此时流量的时延和不同地域间消耗的带宽会发生变化。请确保充分评估后再关闭。
  • enable:开启多地域等价路由。开启多地域等价路由后,从不同地域学到的相同前缀的路由在其他路由属性一致的情况下将会形成等价路由,此时流量的时延和不同地域间消耗的带宽会发生变化。请确保充分评估后再开启。
disable

返回参数

名称 类型 描述 示例值
object

返回结果。

TransitRouterRouteTableId string

自定义路由表ID。

vtb-bp1xbcgpgcz9axl9m****
RequestId string

请求ID。

599904C8-A3DA-4E5F-83B6-D5364E664247

示例

正常返回示例

JSON格式

{
  "TransitRouterRouteTableId": "vtb-bp1xbcgpgcz9axl9m****",
  "RequestId": "599904C8-A3DA-4E5F-83B6-D5364E664247"
}

错误码

Http code 错误码 错误信息 描述
400 InvalidTransitRouterId.NotFound TransitRouterId is not found 参数中指定的TransitRouterId不存在。
400 OperationFailed.CCNTrNotSupport Operation failed because the CCN transit router does not support route table. CCN地域的转发路由器不支持创建路由表。
400 DryRunOperation Request validation has been passed with DryRun flag set. DryRun请求验证通过。
400 MissingParam.TransitRouterId The parameter TransitrouterId is mandatory. 缺少参数TransitRouterId。
400 OperationFailed.BasicTrNotSupport Operation failed because the Basic TransitRouter does not support RouteTable 基础版转发路由器不支持该操作。
400 IncorrectStatus.TransitRouter TransitRouter status is invalid. 当前TransitRouter的状态不支持该操作,请稍后重试。
400 QuotaExceeded.TransitRouterRoutTable TransitRouterRoutTable quota exceeded. 路由表数量已达到上限。
400 OperationUnsupported.MultiRegionEcmp This region does not support MultiRegionEcmp. -

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

变更历史

变更时间 变更内容概要 操作
2023-01-10 OpenAPI 错误码发生变更,OpenAPI 入参发生变更
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    删除错误码:400
入参 OpenAPI 入参发生变更
    新增入参:RouteTableOptions
2023-01-04 OpenAPI 错误码发生变更
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    删除错误码:400