阅读938 返回首页    go 微信

新建路由器接口__高速通道相关接口_API 参考_云服务器 ECS-阿里云

描述

创建一个路由器接口（RouterInterface）。

关于路由器接口的介绍，请参见 阿里云文档-网络产品-高速通道-功能介绍。

高速通道产品处于公测状态。如果您需要使用该功能，请到阿里云官网高速通道产品页 申请公测资格。

  • 该API仅用于生成一个RouterInterface，并未触发连接动作。若要真的实现路由器接口的互联，需要使用后面的“发起路由器接口连接”操作。
  • 路由器接口之间的“互连”，表示两个路由器通过一根虚拟的“链路”连接起来。若要在链路上正确的实现消息的传递，还需要在两边的路由器上正确地配置路由表，以及在实际通信的对象上正确的配置访问控制规则；
  • 任意两个路由器之间，最多只能存在一对互连的RouterInterface。
  • 一个路由器上可以最多创建5个路由器接口。
  • 一个用户名下最多可以同时拥有5个路由器接口。
  • 若用户名下有RI处于欠费状态，则不允许新建更多的路由器接口。
  • OppositeRouterType、OppositeRouterId、OppositeInterfaceId、OppositeInterfaceOwnerId四个参数，用于两个路由器接口互连时进行校验。在发起连接时必须事先填好。所以，您可以选择在创建时就填好，或者创建出路由器接口之后调用ModifyRouterInterfaceAttribute来修改。

对于创建本端或对端是VBR上的Router Interface时：

  • 增加AccessPointId和OppositeAccessPointId参数，描述和限制见以下参数表
  • 新增HealthCheckSourceIp和HealthCheckTargetIp参数，描述和限制见以下参数表
  • VBR只能是发起端，此时对端（接收端）只能是VRouter，具体的限制如下：
    • 如果RouterType（本端）是VBR，Role必须是InitiatingSide，而且OppositeRouterType只能是VRouter并且不能修改
    • 对端是VBR的Router Interface只能是接收端，在创建时必须指定对端的RouterType（VBR）和AccessPointId，而且创建后不能修改这两个属性，具体的限制如下：
    • OppositeRouterType不允许从其他值（VRouter或空）改为VBR，或从VBR改为其他值（VRouter或空）
    • OppositeRouterType是VBR时Role（本端）必须是AcceptingSide，而且OppositeAccessPointId是必填并且不可改
  • 在VBR上创建Router Interface要求VBR必须当时必须处于Enabled状态

请求参数

名称 类型 是否必须 描述
Action String 是 操作接口名，系统规定参数，取值：CreateRouterInterface
RegionId String 是 实例所在的地域
RouterType String 是 所属的路由器类型。
可选值：VRouter，VBR
AccessPointId String 否 所属的接入点ID。在RouterType是VBR时必填，而且创建后不允许修改。在RouterType是VRouter时不能填。
RouterId String 是 所属的路由器Id，在RouterType是VBR时RouterId所指定的VBR必须在AccessPointId所指定的接入点内。
Role String 是 连接中扮演的角色，即，是连接发起端还是连接接受端。
可选值：InitiatingSide|AcceptingSide；
Spec String 是 规格，详见 阿里云文档-网络产品-高速通道-地域、规格与价格
OppositeRegionId String 是 要连接的对端所在的Region.
OppositeAccessPointId String 否 对端所属的接入点ID。在OppositeRouterType是VBR时必填，而且创建后不允许修改。在OppositeRouterType是VRouter时不能填。在OppositeRouterType是VBR时OppositeRouterId所指定的VBR必须在OppositeAccessPointId所指定的接入点内。在创建/修改RouterInterface时不会做对端OppositeRouterId，OppositeAccessPointId等的校验，在进行连接操作时会出错。
OppositeRouterType String 否 要连接的对端路由器接口所属的路由器类型。可选值：VRouter，VBR；缺省为VRouter类型。
OppositeRouterId String 否 要连接的对端的路由器的ID。在OppositeRouterType是VBR时OppositeRouterId所指定的VBR必须在OppositeAccessPointId所指定的接入点内。在创建/修改RouterInterface时不会做对端OppositeRouterId，OppositeAccessPointId等的校验，在进行连接操作时会出错。
OppositeInterfaceId String 否 要连接的对端RouterInterface的Id
OppositeInterfaceOwnerId String 否 连接对端路由器接口的持有者账号ID。您可以登录阿里云官网以后，在 控制台-用户中心-账号管理 中看到您的账号ID。
Name String 否 实例的显示名称，[2, 128] 英文或中文字符，必须以大小字母或中文开头，可包含数字，“.”，“_”或“-”。
实例名称会显示在控制台。
如果没有指定该参数，默认值为实例的 InstanceId
不能以 https:// 和 https:// 开头。
Description String 否 自定义描述[[2, 256] 个字符，实例描述会显示在控制台。不填则为空，默认为空。不能以 https:// 和 https:// 开头
HealthCheckSourceIp String 否 专线容灾和ECMP场景下用来做专线HealthCheck的Packet的Source IP。只对本端是VRouter而且对端是VBR的Router Interface有效。必须是本端VRouter所在的VPC内的一个未被使用的IP。HealthCheckSourceIp与HealthCheckTargetIp必须同时指定或同时不指定。
HealthCheckTargetIp String 否 专线容灾和ECMP场景下用来做专线HealthCheck的Packet的Target IP。只对本端是VRouter而且对端是VBR的Router Interface有效。通常可以用专线用户端CPE的IP（也就是对端RI所在的VBR上的PeerGatewayIp），用户也可以指定专线用户端的其他可以用来做HealthCheck Target的IP。HealthCheckSourceIp与HealthCheckTargetIp必须同时指定或同时不指定。
ClientToken String 否 用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不值过64个ASCII字符。
具体参见附录：如何保证幂等性。

返回参数

名称 类型 描述
RouterInterfaceId String 路由器接口的实例ID，由系统生成，全局唯一。是操作路由器接口实例的唯一标识

错误码

错误代码 描述 Http 状态码 语义
InvalidRegionId.NotFound The RegionId provided does not exist in our records. 404 指定的 RegionId 不存在
InvalidOppositeRegionId.NotFound The OppositeRegionId provided does not exist in our records. 404 用户填写的OppositeRegionId是一个不存在的regionId
InvalidRegionPair.NotReachable The specified OppositeRegion is not reachable by ExpressConnect from that region specified by ‘RegionId’ 400 用户指定的两个region是无法通过高速通道产品进行连接的。
InvalidRole.ValueNotSupported The specified Role is not valid. 400 指定的 Role 不合法
InvalidSpec.ValudNotSupported The specified Spec is not supported. 400 指定的 Spec 不支持
InvalidRouterType.ValueNotSupported The specified RouterType is not valid 400 指定的 RouterType 不合法
InvalidRouterId.NotFound The specified RouterId does not exist in our recored. 404 指定的 RouterId 不存在
InvalidOppositeRouterType.ValueNotSupported The specified OppositeRouterType is not valid. 400 指定的 OppositeRouterType 不合法
ParameterMismatch.Role-Spec The specified Spec and Role mismatch. 400 指定的 Spec 和 Role 不匹配
ParameterMismatch.RegionId-OppositeRegionId-Spec The specified Spec is not supported between the specified RegionId and OppositeRegionId. 400 该规格在这两个Region之间不支持。
InvalidName.Malformed The specified ‘Name’ is not valid. 400 指定的 Name 不合法
InvalidDescription.Malformed The specifid ‘Description’ is not valid. 400 指定的 Description 不合法
Forbidden.BillsOutstanding You cannot create more RouterInterface because you have bills outstanding. 400 有未结清的账单，因而拒绝创建更多的后付费资源；
QuotaExceed.RouterInterface Living RouterInterface quota exceeded. 400 已有路由器接口数量超过配额
LimitationExceed.InterfaceNumberOnRouter Total number of RouterInterfaces on a Router exceeded. 400 单个路由器上存在的路由器接口数量超过配额
Forbidden.NotInRouterInterfaceCreateWhitelist Not in router interface create whitelist. 500 帐号不在创建路由器接的白名单中
RI_CREATE_ONE_LIMIT_BY_SYNC Create ri only one limit by sync. 500
InvalidAccessPoint.ValueNotAllowed The non-vbr router interface cannot have access point configured. 500 非 VBR 路由器接口不能指定接入点信息
InvalidAccessPoint.ValueNotAllowed The non-vbr opposite router interface cannot have opposite access point configured. 500 非 VBR 对端路由器接口不能指定接入点信息
InvalidParam.NotFound Parameter must not be null,uid, bid,regionNo, remoteRegionNo or routerId 400 ‘uid’, ‘bid’, ‘regionNo’, ‘remoteRegionNo’ 或者 ‘routerId’不能为空
InvalidAccessPoint.NotMatch The accessPoint id is not matched 400 接入点Id 不匹配
InvalidAccessPoint.NotExist The accessPoint not exit 400 接入点Id 不存在

最后更新：2016-11-23 16:03:50

  上一篇：go 删除端口转发规则__NAT网关相关接口_API 参考_云服务器 ECS-阿里云
  下一篇：go 修改路由器接口属性__高速通道相关接口_API 参考_云服务器 ECS-阿里云