CreateRouteEntry
在VPC路由器或边界路由器(VBR)上创建自定义路由条目
服务地址:
华东1(杭州)
输入参数
只看必填
RegionId路由表所属地域的ID
RouteTableId 要添加自定义路由条目的路由表ID
DestinationCidrBlock自定义路由条目的目标网段
NextHopId自定义路由条目的下一跳实例的ID
ClientToken客户端Token
RouteEntryName要添加的自定义路由条目的名称
Description自定义路由条目的描述信息
NextHopType自定义路由条目的下一跳的类型
NextHopList下一跳的信息
0下一跳的信息
NextHopIdECMP路由的下一跳实例的ID
WeightECMP路由的下一跳的路由权重
NextHopTypeECMP路由的下一跳的类型
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • CreateRouteEntry 接口属于异步接口,即系统会返回一个实例 ID,但该路由的添加尚未完成,系统后台的启动任务仍在进行。您可以调用 DescribeRouteEntryList 查询路由的添加状态:
    • 当路由处于 Creating 状态时,表示路由添加中。
    • 当路由处于 Created 状态时,表示路由添加完成。
  • CreateRouteEntry 接口不支持在同一个 VPC 或者同一个 VBR 中并发添加自定义路由条目。
  • CreateRouteEntry 接口在并发情况下可能返回 TaskConflict 错误码,请酌情重试。

使用该接口为 VPC 路由器的路由表添加自定义路由条目时,请注意以下事项:

说明 当添加的路由为前缀列表路由时,路由配额的计算为现存路由与前缀列表路由的最大路由条目数之和是否超过路由配额的限制。
  • 同一个路由表中自定义路由条目不能超过 200 条。

  • 自定义路由条目的目标网段(DestinationCidrBlock)不能和 VPC 内的交换机的网段相同,可以包含交换机的网段但是不能被交换机的网段包含。

  • 自定义路由条目的目标网段(DestinationCidrBlock)可以配置为比云服务系统路由网段100.64.0.0/10更明细的网段,但不支持和该网段相同。

    注意 由于目标网段为100.64.0.0/10的系统路由用于 VPC 内的云产品通信,建议您谨慎配置更明细的路由,如果配置错误将导致云产品服务无法正常访问和使用。

  • 同一路由表下的路由条目的目标网段(DestinationCidrBlock)不允许相同。

  • 如果指定的目标网段(DestinationCidrBlock)是一个 IP 地址,会按照 32 位掩码来处理。

  • 多条自定义路由条目可以指向同一个下一跳(NextHopId)。

  • 自定义路由条目的下一跳(NextHopId)必须和路由表在同一个 VPC。

  • 支持通过 NextHopList 参数配置 ECMP 路由:

    • 添加普通(非 ECMP)自定义路由时,需指定 DestinationCidrBlockNextHopTypeNextHopId 参数,且不能指定 NextHopList 参数。

    • 添加 ECMP 路由时,需指定 DestinationCidrBlockNextHopList 参数,且不能指定 NextHopTypeNextHopId 参数。

使用该接口为边界路由器的路由表添加自定义路由条目时,请注意以下事项:

  • 同一个路由表中自定义路由条目不能超过 200 条。

  • 不支持 NextHopList 参数。

  • 自定义路由条目的目标网段(DestinationCidrBlock)可以配置为比云服务系统路由网段100.64.0.0/10更明细的网段,但不支持和该网段相同。

    注意 由于目标网段为100.64.0.0/10的系统路由用于 VPC 内的云产品通信,建议您谨慎配置更明细的路由,如果配置错误将导致云产品服务无法正常访问和使用。

  • 同一路由表下的路由条目的目标网段(DestinationCidrBlock)不允许相同。

  • 如果指定的目标网段(DestinationCidrBlock)是一个 IP 地址,会按照 32 位掩码来处理。

  • 多条自定义路由条目可以指向同一个下一跳(NextHopId)。

  • 自定义路由条目的下一跳(NextHopId)必须是该 VBR 关联的路由器接口。

  • 只允许在 VBR 状态是 Active,而且对应的物理专线状态是 Enabled 且没有被欠费锁定的情况下在 VBR 上新建路由条目。

  • 仅支持添加普通路由(非 ECMP),需指定 DestinationCidrBlockNextHopTypeNextHopId 参数,且不能指定 NextHopList 参数。

请求参数

字段名称字段详情
RegionIdstring

路由表所属地域的 ID。展开详情

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
RouteTableIdstring

要添加自定义路由条目的路由表 ID。

示例值:vtb-bp145q7glnuzd****参考取值来源:
    CreateRouteTable
    DescribeRouteTableList
    PublishVpcRouteEntries
DestinationCidrBlockstring

自定义路由条目的目标网段,支持 IPv4、IPv6、前缀列表的目标网段和前缀列表的实例 ID。需满足以下要求:展开详情

示例值:192.168.0.0/24
NextHopIdstring

自定义路由条目的下一跳实例的 ID。

示例值:i-j6c2fp57q8rr4jlu****
ClientTokenstring

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

示例值:02fb3da4-130e-11e9-8e44-001****
RouteEntryNamestring

要添加的自定义路由条目的名称。展开详情

示例值:test参考取值来源:
    DescribeRouteEntryList
Descriptionstring

自定义路由条目的描述信息。展开详情

示例值:test
NextHopTypestring

自定义路由条目的下一跳的类型,取值: 展开详情

示例值:RouterInterface枚举值:HaVipVpnGatewayGatewayLoadBalancerEndpointVpcPeerInstanceNetworkInterfaceNatGatewayAttachmentIpv4GatewayGatewayEndpointEcrRouterInterfaceIPv6Gateway
NextHopListarray<object>

下一跳的信息。

子级条数 <= 16

返回参数

字段名称字段详情
RouteEntryIdstring

自定义路由条目的 ID。

示例值:rte-sn6vjkioxte1gz83z****
RequestIdstring

请求 ID。

示例值:0ED8D006-F706-4D23-88ED-E11ED28DCAC0
变更历史
暂无变更历史