在企業版轉發路由器的路由表中添加路由條目。
接口說明
CreateTransitRouterRouteEntry 接口屬于異步接口,即系統會先返回一個路由條目 ID,但該路由條目并未創建完成,系統后臺的創建任務仍在進行。您可以調用 ListTransitRouterRouteEntries 接口查詢路由條目的狀態。
- 當路由條目處于 Creating 狀態時,表示路由條目正在創建中。在該狀態下,您只能對該路由條目執行查詢操作,不能執行其他操作。
- 當路由條目處于 Active 狀態時,表示路由條目創建完成。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cen:CreateTransitRouterRouteEntry | create | *TransitRouterRouteTable acs:cen:*:{#accountId}:centransitrouterroutetable/{#centransitrouterroutetableId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 02fb3da4-130e-11e9-8e44-001**** |
TransitRouterRouteEntryName | string | 否 | 路由條目的名稱。 名稱可以為空或長度為 1~128 個字符,不能以 http://或 https://開頭。 | testname |
TransitRouterRouteEntryDescription | string | 否 | 路由條目的描述。 描述可以為空或長度為 1~256 個字符,不能以 http://或 https://開頭。 | testdesc |
TransitRouterRouteTableId | string | 是 | 企業版轉發路由器的路由表 ID。 | vtb-bp1dudbh2d5na6b50**** |
TransitRouterRouteEntryNextHopType | string | 是 | 下一跳類型。取值:
| BlackHole |
TransitRouterRouteEntryDestinationCidrBlock | string | 是 | 路由條目的目標網段,支持 IPv4 地址和 IPv6 地址。 | 192.168.0.0/24 |
TransitRouterRouteEntryNextHopId | string | 否 | 路由條目的下一跳所關聯的網絡實例連接 ID。 | tr-attach-nls9fzkfat8934**** |
DryRun | boolean | 否 | 是否對此次請求執行預檢,包括權限、實例狀態校驗等。取值:
| false |
返回參數
示例
正常返回示例
JSON
格式
{
"TransitRouterRouteEntryId": "rte-75eg4jprkvk0pw****",
"RequestId": "835E7F4B-B380-4E0F-96A5-6EA572388047"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | DryRunOperation | Request validation has been passed with DryRun flag set. | DryRun請求驗證通過。 |
400 | InvalidTransitRouterRouteTableId.NotFound | TransitRouterRouteTableId is not found. | 轉發路由器路由表實例ID未找到。 |
400 | TransitRouterRouteEntryNextHopId.NotFound | TransitRouterRouteEntryNextHopId is not found. | 轉發路由器路由條目下一跳實例ID不存在。 |
400 | OperationFailed.CreateRouteEntryWithCCNAttachment | Operation failed because Create RouteEntry to CCN Attachment does not support. | 不支持創建指向CCN attachment的路由。 |
400 | QuotaExceeded.TransitRouterRoutEntry | TransitRouterRoutEntry quota exceeded. | 路由數量已達到上限。 |
400 | IllegalParam.TransitRouterDestinationCidrBlock | TransitRouterDestinationCidrBlock is illegal. | 參數中指定的TransitRouterDestinationCidrBlock不合法。 |
400 | InstanceExist.TransitRouterRouteEntry | The instance TransitRouterRouteEntry already exists. | 轉發路由器路由條目實例已存在。 |
400 | IncorrectStatus.TransitRouterRouteTable | TransitRouterRouteTable status is invalid. | 轉發路由器路由表狀態非法。 |
400 | ParamExclusive.RouteEntryIdAndRouteTableIdOrDestCidrBlock | RouteEntryId and TransitRouterRouteTableIdOrDestCidrBlock is mutually exclusive. | RouteEntryId, TransitRouterRouteTableId或DestCidrBlock參數互斥。 |
400 | InvalidDescription | Description is invalid. | 描述不合法。 |
400 | InvalidName | Name is invalid. | name不合法。 |
400 | IllegalParam.NextHopType | The NextHopType is illegal. | 參數中指定的NextHopType不合法。 |
400 | MissingParam.TransitRouterRouteEntryNextHopId | The parameter TransitRouterRouteEntryNextHopId is mandatory | 缺少參數TransitRouterRouteEntryNextHopId。 |
400 | InvalidTransitRouterRouteEntryNextHopId.NotFound | TransitRouterRouteEntryNextHopId is not found | TransitRouterRouteEntryNextHopId不存在。 |
400 | OperationFailed.CreateRouteEntryWithSameDestinationCidrBlock | Operation failed because Create RouteEntry with same destination cidrblock does not support. | 不允許創建目的網段相同的路由表項。 |
400 | InvalidDestinationCidrBlock.NotFound | DestinationCidrBlock is not found. | 參數中指定的DestinationCidrBlock不存在。 |
400 | OperationFailed.CreateRouteEntryWithConnectAttachment | Operation failed because Create RouteEntry to connect Attachment does not support. | 不支持創建指向connect attachment的路由。 |
400 | ParamExclusive.NextHopTypeBlackHoleAndNextHopId | TransitRouterRouteEntryNextHopType(BlackHole) and TransitRouterRouteEntryNextHopId is mutually exclusive. | 當路由條目中“是否為黑洞路由”勾選“是”時,請不要指定“下一跳連接”。 |
400 | InvalidTransitRouterMode.NeedUpgrade | TransitRouter need to upgrade. | 當前轉發路由器模式不支持。 |
400 | OperationFailed.CreateTransitRouterRouteEntryWithVPCAttachment | The specified VPC Attachment has not enable IPv6. | 指定的VPC Attachment未使能IPv6. |
400 | OperationFailed.CreateTransitRouterRouteEntryWithVPNAttachment | Create RouteEntry to VPN Attachment does not support IPv6. | 不支持創建指向VPN Attachment的IPv6路由條目,請確認后再進行操作。 |
400 | NotSupport.AttachmentRoute | Not support such attachment route. | 不支持這種連接路由。 |
400 | InvalidParameter | Invalid parameter. | 參數不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號無權限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-07-10 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-04-19 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-10-18 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-06-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-01-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |