調用ModifyVirtualBorderRouterAttribute接口修改邊界路由器VBR(Virtual Border Router)的配置。
接口說明
-
VlanId 只允許物理專線的所有者修改。
-
同一物理專線下的同一 VLAN ID 不允許被兩個 VBR 同時使用。
-
進入 terminated 狀態的 VBR 會在 7 天內自動保留其 VLAN ID,不允許其他 VBR 使用。7 天后可以被其他 VBR 使用。
-
其他賬號的 VBR 實例,不能配置 LocalGatewayIp、PeerGatewayIp 和 PeeringSubnetMask。
-
PeeringSubnetMask 支持 24~30 位(255.255.255.0~255.255.255.252)。
-
LocalGatewayIp 和 PeerGatewayIp 必須在同一個網段內。例如,LocalGatewayIp:192.168.XX.XX,PeerGatewayIp:192.168.XX.XX,PeeringSubnetMask:255.255.255.248。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vpc:ModifyVirtualBorderRouterAttribute | update | *VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | VBR 所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-shanghai |
VbrId | string | 是 | VBR 實例 ID。 | vbr-bp1lhl0taikrte**** |
VlanId | integer | 否 | VBR 的 VLAN ID,取值范圍:0~2999。 說明
只有物理專線的所有者可以指定該參數,同一條物理專線下的兩個 VBR 的 VLAN ID 不能相同。
| 0 |
CircuitCode | string | 否 | 運營商為物理專線提供的電路編碼。 說明
只有物理專線的所有者可以指定該參數。
| longtel001 |
LocalGatewayIp | string | 否 | VBR 實例的阿里云側互聯 IP。 該屬性只允許 VBR 所有者指定或修改。 | 192.168.XX.XX |
PeerGatewayIp | string | 否 | VBR 實例的客戶側互聯 IP。 該屬性只允許 VBR 所有者指定或修改。 | 192.168.XX.X |
PeeringSubnetMask | string | 否 | VBR 實例的阿里云側和客戶側互聯 IP 的子網掩碼。該屬性只允許 VBR 所有者指定或修改。 兩個 IP 地址必須位于同一個子網中。 | 255.255.255.252 |
MinTxInterval | long | 否 | 配置 BFD 報文的發送間隔,取值:200~1000,單位:ms。 | 300 |
MinRxInterval | long | 否 | 配置 BFD 報文的接收間隔,取值:200~1000,單位:ms。 | 300 |
DetectMultiplier | long | 否 | 檢測時間倍數,即接收方允許發送方發送報文的最大連接丟包數,用來檢測鏈路是否正常。 取值:3~10。 | 3 |
Description | string | 否 | VBR 的描述信息。 長度為 2~256 個字符,必須以字母或中文開頭,但不能以 | desc |
Name | string | 否 | VBR 的名稱。 長度為 2~128 個字符,必須以字母或中文開頭,可包含數字、下劃線(_)和短劃線(-)。但不能以 | VBR |
AssociatedPhysicalConnections | string | 否 | VBR 關聯的物理專線的列表信息,包含以下參數:
| [ { "CircuitCode ": "longtel001", " LocalGatewayIp ": "192.168.XX.XX", "PeerGatewayIp" : "192.168.XX.XX", " PeeringSubnetMask ": "255.255.255.252", " PhysicalConnectionId ": "pc-kojok19****" } ] |
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 02fb3da4-130e-11e9-8e44-00**** |
LocalIpv6GatewayIp | string | 否 | VBR 實例的阿里云側互聯 IPv6 地址。 | 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b |
PeerIpv6GatewayIp | string | 否 | VBR 實例的客戶側互聯 IPv6 地址。
| 2001:XXXX:3c4d:0015:0000:0000:0000:2a2b |
PeeringIpv6SubnetMask | string | 否 | VBR 實例的阿里云側和客戶側互聯 IPv6 的子網掩碼。 兩個 IPv6 地址必須位于同一個子網中。 | 2408:4004:cc:400::/56 |
EnableIpv6 | boolean | 否 | 是否啟用 IPv6。
| false |
Bandwidth | integer | 否 | 帶寬值。單位:Mbps。 | 100 |
SitelinkEnable | boolean | 否 | 是否允許 IDC 間業務訪問。
| false |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "980960B0-2969-40BF-8542-EBB34FD358AB"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | IllegalParam.AssociatedPhysicalConnections | The specified AssociatedPhysicalConnections is illegal. | 指定的AssociatedPhysicalConnections不合法。 |
400 | IllegalParam.IpAddress | The specified IpAddress is illegal. | 指定的IpAddress不合法 |
400 | IllegalParam.CidrBlock | The specified CidrBlock is illegal. | CidrBlock參數非法。 |
400 | InvalidVbrId.NotFound | The specified VirutalBorderRouter is not found. | 該邊界路由器不存在,請您檢查輸入的邊界路由器是否正確。 |
400 | IllegalParam.MinTxInterval | The specified MinTxInterval is not in proper range. | 指定的 MinTxInterval 不在適當的范圍內。 |
400 | IllegalParam.MinRxInterval | The specified MinRxInterval is not in proper range. | 指定的 MinRxInterval 不在適當的范圍內。 |
400 | IllegalParam.DetectMultiplier | The specified DetectMultiplier is not in proper range. | DetectMultiplier參數不在適當范圍內。 |
400 | InvalidVlanId.Used | The specified VlanId has been used. | 該VLAN已經被占用。 |
400 | Duplicated.LocalGatewayIp | The specified LocalGatewayIps are duplicated. | - |
400 | Duplicated.PeerGatewayIp | The specified PeerGatewayIp are duplicated. | - |
400 | IllegalParam.LocalGatewayIp | The specified LocalGatewayIp already exists. | - |
400 | IllegalParam.PeerGatewayIp | The specified PeerGatewayIp already exists. | - |
400 | InvalidCircuitCode.Malformed | The specified CircuitCode is not valid. | 該CircuitCode不合法。 |
400 | InvalidVlanId.Malformed | The specified VlanId is not valid. | 參數VlanId的值不合法。 |
400 | InvalidIp.Malformed | The specified ip address is not valid. | 指定的私網 IP 不合法,請您檢查該私網IP是否正確。 |
400 | InvalidPeeringSubnetMask.Malformed | The specified PeeringSubnetMask is not valid. | 指定的PeeringSubnetMask不合法,請您檢查該參數是否正確。 |
400 | InvalidName.Malformed | The specified Name is not valid. | 參數Name值不合法 |
400 | InvalidDescription.Malformed | The specifid Description is not valid. | 參數Description值不合法 |
400 | MissingParameter | LocalGatewayIp, peerGatewayIp and peeringSubnetMask must not be null. | 參數缺失LocalGatewayIp,peerGatewayIp,peeringSubnetMask不能為空 |
400 | InvalidIp.NotSameSubnet | Local gateway ip and peer gateway ip are not in the same subnet. | 本地網關IP地址與對端網關IP地址不在同一個子網內。 |
400 | InvalidParameter | %s | - |
400 | OperationFailed.VlanIdInUse | Operation failed because vlanId is in use. | vlanId已經被使用 |
400 | IncorrectStatus.VirtualBorderRouter | %s | - |
400 | OperationUnsupported.IPV6ForThisRegion | This Region do not support IPV6. | 地域不支持IPV6 |
400 | OperationFailed.PconnTrafficNotEnable | The operation is failed because of PconnTrafficNotEnable. | 操作失敗,因為出方向流量未開通。 |
400 | OperationDenied.VBRAssociateVPconn | The operation is not allowed because of VBRAssociateVPconn. | VBR不允許綁定Vpconn |
400 | OperationFailed.PhysicalConnectionFinancialLocked | Update failed, the physical connection is financial locked. | 共享端口為欠費鎖定狀態,無法修改vlan。 |
400 | OperationFailed.PhysicalConnectionTerminated | Update failed, the physical connection is terminated. | 共享端口為已終止狀態,無法修改vlan。 |
400 | DuplicatedParam.LocalGatewayIp | The LocalGatewayIp values are duplicated. | 互聯IP重復,請更換后重試。 |
400 | Forbidden.VbrNotAllowModifySiteLink | Can not modify virtualBorderRouter site link, please call PD to authorize. | - |
400 | OperationUnsupported.VirtualBorderRouterEnableIPv6 | The operation failed. The device or region does not support IPv6 functions. | 操作失敗,設備或region不支持IPv6功能 |
400 | OperationFailed.PconnAllocateVlan0 | Vlan 0 Vbr cannot share the physical connection with another Vbr. | 物理專線上Vlan 0 不能和其他Vbr共存 |
403 | Forbidden.CircuitCodeNotAllowedByCaller | The caller is not allowed to modify. | 不允許修改CircuitCode參數。 |
403 | Forbidden.CircuitCodeNotAllowedByCaller | The caller is not allowed to specify the CircuitCode parameter. | 不允許指定CircuitCode參數。 |
403 | Forbidden.LocalGatewayIpNotAllowedByCaller | The caller is not allowed to specify the LocalGatewayIp parameter. | 不允許指定LocalGatewayIp參數。 |
403 | Forbidden.PeerGatewayIpNotAllowedByCaller | The caller is not allowed to specify the PeerGatewayIp parameter. | 不允許指定PeerGatewayIp參數。 |
403 | Forbidden.PeeringSubnetMaskNotAllowedByCaller | The caller is not allowed to specify the PeeringSubnetMask parameter. | 不允許指定PeeringSubnetMask參數。 |
403 | Forbidden.VlanIdNotAllowedByCaller | The caller is not allowed to specify the VlanId. | 不允許指定VLAN ID。 |
403 | Forbidden.NameNotAllowedByCaller | The caller is not allowed to specify the Name parameter. | 不允許指定Name參數。 |
403 | Forbidden.DescriptionNotAllowedByCaller | The caller is not allowed to specify the Description parameter. | 不允許指定Description參數。 |
404 | InvalidRegionId.NotFound | The specified RegionId is not found. | 指定的RegionId不存在,請您檢查此產品在該地域是否可用。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-06-28 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-05-08 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-04 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-26 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |