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