調用CreateRouterInterface接口創建路由器接口。
接口說明
調用本接口創建路由器接口時，請注意：
-
任意兩個路由器之間，最多只能存在一對互連的路由器接口。
-
一個路由器上可以最多創建 5 個路由器接口。
-
如果賬戶下存在欠費狀態的路由器接口，則無法再創建路由器接口。
-
同一路由表下的路由條目的目標網段（DestinationCidrBlock）不允許相同。
-
邊界路由器 VBR（Virtual Border Router）只能是連接發起端，并且是已激活狀態。
-
通過本接口可以創建預付費和后付費的路由器接口。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:CreateRouterInterface | create | *VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId}*RouterInterface acs:vpc:{#regionId}:{#accountId}:routerinterface/* |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 路由器接口所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
| Role | string | 是 | 路由器接口的角色，取值：
| InitiatingSide |
| OppositeRegionId | string | 是 | 連接接收端所在的地域 ID。 | cn-shanghai |
| Spec | string | 是 | 路由器接口的規格?？捎玫囊幐窈蛯膸捜≈等缦拢?/p>
說明
當 Role 為 AcceptingSide（連接接收端）時，Spec 取值為 Negative 即創建接收端路由器接口時不涉及規格。
| Mini.2 |
| RouterType | string | 是 | 路由器接口關聯的路由器類型，取值：
| VRouter |
| RouterId | string | 是 | 路由器接口關聯的路由器 ID。 | vbr-m5ebm6g9ptc9mly1c**** |
| OppositeInterfaceId | string | 否 | 對端路由器接口 ID。 | ri-2zeo3xzyf38r4urzd**** |
| OppositeRouterId | string | 否 | 對端路由器的 ID。 | vrt-bp1lhl0taikrteen8**** |
| OppositeRouterType | string | 否 | 對端路由器接口關聯的路由器類型，取值：
| VRouter |
| OppositeInterfaceOwnerId | string | 否 | 對端路由器接口的所有者的阿里云賬號 ID。 | 253460731706911258 |
| HealthCheckSourceIp | string | 否 | 健康檢查源 IP 地址，必須是本端 VPC 內的一個未被使用的 IP。 說明
物理專線接入場景下可指定該參數。
| 192.168.0.6 |
| HealthCheckTargetIp | string | 否 | 健康檢查目的 IP 地址。 說明
當指定了 HealthCheckSourceIp 后，該參數必填。
| 192.168.0.8 |
| AccessPointId | string | 否 | ap-cn-hangzhou-yh-ts-A | |
| OppositeAccessPointId | string | 否 | 對端所屬的接入點 ID。 說明
對端路由器接口位于 VBR 上時需指定該參數，創建路由器接口后無法修改。
| ap-cn-shanghai-nt-aligroup-C |
| Description | string | 否 | 路由器接口的描述信息。 長度為 2~256 個字符，必須以字母或中文開頭，但不能以 | abcabc |
| Name | string | 否 | 路由器接口的名稱。 長度為 2~128 個字符，必須以字母或中文開頭，可包含數字、半角句號（.）、下劃線（_）和短劃線（-）。 | abc |
| Period | integer | 否 | 購買時長，取值：
說明
InstanceChargeType 參數的值為 PrePaid 時，該參數必填。
| 3 |
| InstanceChargeType | string | 否 | 路由器接口的付費方式，取值：
| PrePaid |
| AutoPay | boolean | 否 | 是否自動付費，取值：
說明
InstanceChargeType 參數的值為 PrePaid 時，該參數必填。
| false |
| PricingCycle | string | 否 | 預付費的計費周期，取值：
說明
InstanceChargeType 參數的值為 PrePaid 時，該參數必填。
| Month |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 由客戶端生成該參數值，要保證在不同請求間唯一。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。
| 123e4567-e89b-12d3-a456-426655440000 |
| FastLinkMode | boolean | 否 | 是否為使用快速連接模式創建的 VBR 上聯路由器接口，快速連接模式可實現 VBR 和 VPC 兩端路由器接口創建完畢后自動完成連接。取值：
說明
| false |
| AutoRenew | boolean | 否 | 是否開通自動續費。取值：
| false |
| ResourceGroupId | string | 否 | 資源組 ID。 關于資源組的更多信息，請參見什么是資源組。 | rg-acfmxazb4ph6aiy**** |
| Tags | array<object> | 否 | 資源的標簽。 | |
| object | 否 | 標簽。 | ||
| Key | string | 否 | 資源的標簽鍵。至少輸入 1 個標簽鍵，最多支持輸入 20 個標簽鍵。如需傳入該值，則不能輸入空字符串。 一個標簽鍵最多支持 128 個字符，不能以 | FinanceDept |
| Value | string | 否 | 資源的標簽值。最多支持輸入 20 個標簽值。如果傳入該值，可以輸入空字符串。 最多支持 128 個字符，不能以 | FinanceJoshua |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "079874CD-AEC1-43E6-AC03-ADD96B6E4907",
"OrderId": 20210101123456,
"RouterInterfaceId": "ri-2ze7fbuohm****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidPrice.NotFound | Pricing plan result not found. | Price參數無效 |
| 400 | InvalidAliuid | Invalid Aliuid. | Aliuid無效 |
| 400 | InvalidRole.ValueNotSupported | The specified Role is not valid. | 指定的 Role 不合法，請您檢查該參數是否正確。 |
| 400 | InvalidSpec.ValudNotSupported | The specified Spec is not supported. | 該規格不支持該操作，請您更換規格后重試。 |
| 400 | InvalidRouterType.ValueNotSupported | The specified RouterType is not valid. | 該路由器類型不合法。 |
| 400 | InvalidName.Malformed | The specified "Name" is not valid. | 該名稱格式不合法。 |
| 400 | Forbidden.BillsOutstanding | You cannot create more RouterInterface because you have bills outstanding. | 無法創建路由器接口，您有未結算的賬單。 |
| 400 | LimitationExceed.InterfaceNumberOnRouter | Total number of RouterInterfaces on a Router exceeded. | 路由器接口數量已達到配額上限。 |
| 400 | Forbidden.NotInRouterInterfaceCreateWhitelist | Not in router interface create whitelist. | 不在路由器接口的白名單中。 |
| 400 | RI_CREATE_ONE_LIMIT_BY_SYNC | Create ri only one limit by sync. | 限制同步創建路由器接口。 |
| 400 | InvalidAccessPoint.ValueNotAllowed | The non-vbr router interface cannot have access point configured. | 非邊界路由器的路由器接口不能配置接入點。 |
| 400 | InvalidAccessPoint.ValueNotAllowed | The non-vbr opposite router interface cannot have opposite access point configured. | 非邊界路由器的路由器接口不能配置接入點。 |
| 400 | InvalidParam.NotFound | Parameter must not be null,uid, bid,regionNo, remoteRegionNo, routerId or accessPointId | 參數不能為null |
| 400 | InvalidAccessPoint.NotMatch | The accessPoint id is not matched | 該接入點ID不正確。 |
| 400 | InvalidAccessPoint.NotExist | The accessPoint not exit | 該接入點不存在。 |
| 400 | InvalidRouterType.ValueNotSupported | The specified RouterType is not valid | 該路由器類型不合法。 |
| 400 | INVAID_VBR_STATUS | VBR status must be active | - |
| 400 | IncorrectStatus.CenStatus | Cen status must not be middle status. | 請檢查cen 狀態 |
| 400 | Forbidden.AcceptRoleNotSupportPrePay | Acception side ri not support chargetype for prepaid. | 不支持預付費的費用類型。 |
| 400 | InvalidRouterInterfaceSpec.Malformed | Specified RouterInterface spec is not valid. | 指定的RouterInterface Spec無效。 |
| 400 | VpcSubnet.NotFound | Vpc subnet not exist. | Vpc子網不存在。 |
| 400 | IllegalParam.HealthcheckIp | Healthcheck ip cannot equal with instance ip. | Healthcheck ip不能與實例ip相等。 |
| 400 | OperationFailed.HcForInvalidRiType | Healthchecksourceip and healthchecktargetip is only valid for vr ri that is connected to vbr. | 健康檢查IP無效 |
| 400 | OperationFailed.SyncOrderToSub | SyncOrderToSub error. | 操作失敗 |
| 400 | IllegalParam.CrossBorderBandwidth | CrossBorder bandwidth error. | 跨域帶寬包不合法 |
| 400 | IllegalParam.VRouterType | The VRouterType is not supported. | VRouterType不合法 |
| 400 | IllegalParam.Spec | The spec is illegal. | spec不合法 |
| 400 | Forbidden.CrossBorder | User not authorized to create cross border routerInterface. | 用戶無權創建跨境routerInterface |
| 400 | InvalidRouterId.NotFound | Param is not valid,this user does not have this router or aliuid bid regionNo and routerId must have something wrong. | RouterId參數無效 |
| 400 | InvalidCommodity.NotFound | Commodity is not exist. | Commodity不存在 |
| 400 | InvalidRouterInterfaceChargeType.Malformed | Specified RouterInterface ChargeType is not valid. | 指定的RouterInterface ChargeType無效。 |
| 400 | IllegalParam.RegionId | The specified regionId is illegal. | regionId不合法 |
| 400 | PAY.MAYI_WITHHOLDING_AGREEMENT_ILLEGAL | User withhoding argeement is illegal. | - |
| 400 | QuotaExceeded | RiPerUser quota exceeded | 當前用戶建立的對等連接路由器接口數量已達上限 |
| 400 | OperationFailed.PconnTrafficNotEnable | The operation is failed because of PconnTrafficNotEnable. | 操作失敗，因為出方向流量未開通。 |
| 400 | InvalidRegionId.NotFound | The regionId provided does not exist in ec region list. | 提供的regionId無效，請檢查。 |
| 400 | ResourceNotInResourceGroup | The specified resource is not in the specified ResourceGroup. | 輸入的資源不在輸入的資源組內 |
| 400 | HaveConnectionBetweenRouters | Have connection between routers | 兩個路由器之間已經創建了連接 |
| 400 | InvalidDescription.Malformed | The specified "Description" is not valid. | 描述的長度可以是2到256個字符，不能以http://和https://開頭。 |
| 400 | InvalidBandwidth.NotEnough | Bandwidth not enough. | 帶寬計劃的帶寬不足。 |
| 400 | ForbiddenAction | The user does not support this action. | 您沒有所需的權限。 |
| 400 | OperationFailed.NotSupportIPv6 | Router interface not support IPv6. | 路由接口不支持IPv6。 |
| 400 | InvalidParam.AvailableZoneId | The specified AvailableZoneId did not retrieve the corresponding cluster IP address. | 您指定的AvailableZoneId沒有獲取到對應的集群IP地址。 |
| 400 | OperationFailed.NoAvailableAmount | The available amount of your account is less than 0, please recharge before attempting to purchase. | 您的賬戶可用額度小于0，請先充值后再嘗試購買。 |
| 400 | OperationFailed.OperationLocked | Operation failed because OperationLocked. | 操作失敗因為實例已經被運維鎖定。 |
| 400 | OperationFailed.InvalidEcGrant | The VBR have no grant to create EC. | VBR 實例未獲得 VPC 實例授權 ，請授權后重試。 |
| 404 | InvalidRegionId.NotFound | The regionId provided does not exist in our records. | 指定的RegionId不存在。請檢查該參數是否正確。 |
| 404 | InvalidRouterId.NotFound | The specified RouterId does not exist in our recored. | 該 RouterId 不存在。 |
| 404 | InvalidRegionId.NotFound | The parameter wrong, pageNum or pageSize. | 參數錯誤 |
| 404 | InvalidRouterId.AttacedToCEN | Can not create ri when attaced to CEN. | ri不能附加cen |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-06-28 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-05-08 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-04-17 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-12-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-12-21 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-09-11 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-07-20 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-05-18 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |