調用DeleteTransitRouterRouteEntry接口刪除企業版轉發路由器路由表中黑洞、連接實例類型的靜態配置路由條目。
接口說明
在您調用本接口刪除路由條目前，請先了解以下信息：
-
如果您通過 TransitRouterRouteEntryId 刪除指定的路由條目，則您無需填寫 TransitRouterRouteTableId 和 TransitRouterRouteEntryDestinationCidrBlock 參數的值，否則會產生參數互斥。
-
如果您未通過 TransitRouterRouteEntryId 刪除指定的路由條目，則您需依據路由條目的下一跳類型，填寫相應參數：
- 如果您要刪除黑洞路由，則您需要填寫 TransitRouterRouteTableId、TransitRouterRouteEntryDestinationCidrBlock、TransitRouterRouteEntryNextHopType 參數的值。
- 如果您要刪除非黑洞路由，則您需要填寫 TransitRouterRouteTableId、TransitRouterRouteEntryDestinationCidrBlock、TransitRouterRouteEntryNextHopType、TransitRouterRouteEntryNextHopId 參數的值。
-
DeleteTransitRouterRouteEntry 接口屬于異步接口，即系統會先返回一個 RequestId，但路由條目并未刪除完成，系統后臺的刪除任務仍在進行。您可以調用 ListTransitRouterRouteEntries 接口查詢路由條目的狀態。
- 當路由條目處于 Deleting 狀態時，表示路由條目正在刪除中。在該狀態下，您只能對該路由條目執行查詢操作，不能執行其他操作。
- 當查詢不到指定的路由條目時，表示該路由條目刪除完成。
使用限制
本接口只能刪除靜態配置的路由條目，不支持刪除自動學習的路由條目。您可以通過調用 ListTransitRouterRouteEntries 接口查詢路由條目的類型。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| cen:DeleteTransitRouterRouteEntry | delete | *TransitRouterRouteEntry acs:cen:*:{#accountId}:centransitrouterroutentry/{#centransitrouterroutentryId}*TransitRouterRouteTable acs:cen:*:{#accountId}:centransitrouterroutentry/{#transitrouterroutetableId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 02fb3da4-130e-11e9-8e44-001**** |
| DryRun | boolean | 否 | 是否對此次請求執行預檢，包括權限、實例狀態校驗等。取值：
| false |
| TransitRouterRouteEntryId | string | 否 | 路由條目 ID。 | rte-75eg4jprkvk0pw**** |
| TransitRouterRouteEntryNextHopType | string | 否 | 下一跳類型。取值：
| BlackHole |
| TransitRouterRouteEntryDestinationCidrBlock | string | 否 | 目的網段。 | 192.168.0.0/24 |
| TransitRouterRouteEntryNextHopId | string | 否 | 路由條目的下一跳所關聯的網絡實例連接 ID。 | tr-attach-nls9fzkfat8934**** |
| TransitRouterRouteTableId | string | 否 | 企業版轉發路由器路由表 ID。 | vtb-bp1dudbh2d5na6b50**** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | DryRunOperation | Request validation has been passed with DryRun flag set. | DryRun請求驗證通過。 |
| 400 | IllegalParam.TransitRouterRouteEntryId | TransitRouterRouteEntryId is not found. | 參數中指定的TransitRouterRouteEntryId不合法。 |
| 400 | ParamExclusive.RouteEntryIdAndRouteTableIdOrDestCidrBlock | RouteEntryId and TransitRouterRouteTableIdOrDestCidrBlock is mutually exclusive. | RouteEntryId， TransitRouterRouteTableId或DestCidrBlock參數互斥。 |
| 400 | InvalidTransitRouterRouteTableId.NotFound | TransitRouterRouteTableId is not found. | 轉發路由器路由表實例ID未找到。 |
| 400 | InvalidDestinationCidrBlock.NotFound | DestinationCidrBlock is not found. | 參數中指定的DestinationCidrBlock不存在。 |
| 400 | OperationFailed.DeleteTransitRouterRouteEntry | Operation failed because this route entry is created automatically. | 系統自動創建的路由不能刪除。 |
| 400 | IllegalParam.NextHopType | The NextHopType is illegal. | 參數中指定的NextHopType不合法。 |
| 400 | IllegalParam.TransitRouterRouteTableId | The transitRouter route table id is illegal. | 參數中指定的TransitRouterRouteTableId不合法。 |
| 400 | MissingParam.TransitRouterRouteEntryNextHopId | The parameter TransitRouterRouteEntryNextHopId is mandatory | 缺少參數TransitRouterRouteEntryNextHopId。 |
| 400 | InvalidParameter | Invalid parameter. | 參數不合法。 |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號無權限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-07-10 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-10-18 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-01-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |