新建路由器接口
描述
创建一个路由器接口(RouterInterface)。
关于路由器接口的介绍,请参见 阿里云文档-网络产品-高速通道-功能介绍。
高速通道产品处于公测状态。如果您需要使用该功能,请到阿里云官网高速通道产品页 申请公测资格。
该API仅用于生成一个RouterInterface,并未触发连接动作。若要真的实现路由器接口的互联,需要使用后面的“发起路由器接口连接”操作。
路由器接口之间的“互连”,表示两个路由器通过一根虚拟的“链路”连接起来。若要在链路上正确的实现消息的传递,还需要在两边的路由器上正确地配置路由表,以及在实际通信的对象上正确的配置访问控制规则;
任意两个路由器之间,最多只能存在一对互连的RouterInterface。
一个路由器上可以最多创建5个路由器接口。
一个用户名下最多可以同时拥有5个路由器接口。
若用户名下有RI处于欠费状态,则不允许新建更多的路由器接口。
OppositeRouterType、OppositeRouterId、OppositeInterfaceId、 OppositeInterfaceOwnerId四个参数,用于两个路由器接口互连时进行校验。在发起连接时必须事先填好。所以,您可以选择在创建时就填好,或者创建出路由器接口之后调用ModifyRouterInterfaceAttribute来修改。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 操作接口名,系统规定参数,取值:CreateRouterInterface |
RegionId | String | 是 | 实例所在的地域 |
RouterType | String | 是 | 所属的路由器类型。目前仅支持VRouter这一种类型。 可选值:VRouter |
RouterId | String | 是 | 所属的路由器Id |
Role | String | 是 | 连接中扮演的角色,即,是连接发起端还是连接接受端。 可选值:InitiatingSide|AcceptingSide; |
Spec | String | 是 | 规格,详见 阿里云文档-网络产品-高速通道-地域、规格与价格 |
OppositeRegionId | String | 是 | 要连接的对端所在的Region. |
OppositeRouterType | String | 否 | 要连接的对端路由器接口所属的路由器类型。目前仅支持VRouter这一种类型。 可选值:VRouter |
OppositeRouterId | String | 否 | 要连接的对端的路由器的ID。 |
OppositeInterfaceId | String | 否 | 要连接的对端RouterInterface的Id |
OppositeInterfaceOwnerId | String | 否 | 连接对端路由器接口的持有者账号ID。您可以登录阿里云官网以后,在 控制台-用户中心-账号管理 中看到您的账号ID。 |
Name | String | 否 | 实例的显示名称,[2, 128] 英文或中文字符,必须以大小字母或中文开头,可包含数字,“.”,“_”或“-”。 实例名称会显示在控制台。 如果没有指定该参数,默认值为实例的 InstanceId 不能以 http:// 和 https:// 开头。 |
Description | String | 否 | 自定义描述[[2, 256] 个字符,实例描述会显示在控制台。不填则为空,默认为空。不能以 http:// 和 https:// 开头 |
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 不存在 |