調用DescribeRouteEntryList查詢路由條目列表。
接口說明
調用 DeleteRouteEntry 接口刪除路由條目前,您可以調用本接口查詢要刪除的路由條目的下一跳信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vpc:DescribeRouteEntryList | get | *RouteTable acs:vpc:{#regionId}:{#accountId}:routetable/{#RouteTableId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 路由條目所在路由表的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
RouteTableId | string | 是 | 要查詢的路由表的 ID。 | vtb-bp1r9pvl4xen8s9ju**** |
RouteEntryId | string | 否 | 要查詢的路由條目的 ID。 | rte-bp1mnnr2al0naomnp**** |
DestinationCidrBlock | string | 否 | 路由條目的目標網段,支持 IPv4 和 IPv6 網段。 | 192.168.2.0/24 |
RouteEntryName | string | 否 | 路由條目的名稱。 名稱長度為 1~128 個字符,不能以 | abc |
IpVersion | string | 否 | IP 協議的版本。取值:
| ipv4 |
RouteEntryType | string | 否 | 路由的類型。取值:
| System |
NextHopId | string | 否 | 下一跳實例 ID。 | vpn-bp10zyaph5cc8b7c7**** |
NextHopType | string | 否 | 下一跳類型。取值:
| Instance |
MaxResult | integer | 否 | 分批次查詢時每次顯示的條目數。取值范圍:1~100,默認值為 10。 | 10 |
NextToken | string | 否 | 是否擁有下一次查詢的令牌(Token)。取值:
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
ServiceType | string | 否 | 路由托管的類型。如果該字段為空,即表示該路由沒有被托管。 取值:TR,表示托管類型為轉發路由器類型。 | TR |
DestCidrBlockList | array | 否 | 路由條目的目標網段列表。 | |
string | 否 | 路由條目的目標網段列表信息。最多支持輸入 20 個目標網段。 | 192.168.0.0/24 |
返回參數
示例
正常返回示例
JSON
格式
{
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
"RouteEntrys": {
"RouteEntry": [
{
"Status": "Available",
"Type": "System",
"IpVersion": "ipv4",
"Description": "RouteEntryDescription",
"RouteEntryName": "aaa",
"DestinationCidrBlock": "192.168.2.0/24",
"RouteEntryId": "rte-bp1mnnr2al0naomnp****",
"RouteTableId": "vtb-bp15w5q90d2rk3bww****",
"GmtModified": "2022-05-09T03:00:07Z",
"NextHops": {
"NextHop": [
{
"NextHopRegionId": "cn-hangzhou",
"Weight": 100,
"NextHopId": "vpn-bp10zyaph5cc8b7c7****",
"Enabled": 1,
"NextHopType": "Instance",
"NextHopRelatedInfo": {
"InstanceId": "vpc-bp1t36rn9l53iwbsf****",
"InstanceType": "VPC",
"RegionId": "ch-hangzhou"
}
}
]
},
"ServiceType": "TR",
"Origin": "RoutePropagation"
}
]
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | IllegalParam.NextToken | User nextToken is illegal. | - |
400 | InvalidNextHop.NotFound | The specified route entry nexthop does not exist in our records. | - |
400 | OperationFailed.QueryCenEntry | Operation is denied because getting CEN route entry has failed. | 由于暫時無法獲取云企業網路由導致查詢失敗。 |
400 | OperationDenied.UseGatewayRouteEntryQueryInterface | Use listGatewayRouteTableEntries to describe gateway route entries. | 查詢網關路由表路由條目,請使用listGatewayRouteTableEntries接口。 |
400 | InvalidRouteTable.NotFound | The specified RouteTable was not found. | 指定的路由表未找到。 |
400 | IllegalParam.RouteEntryType | The parameter of RouteEntryType is illegal. | 參數RouteEntryType非法。 |
400 | MissingParam.context | The param of context is missing. | 參數context缺失。 |
400 | MissingParam.aliUid | The param of aliUid is missing. | 參數aliUid缺失。 |
400 | MissingParam.bid | The param of bid is missing. | 參數bid缺失。 |
400 | IllegalParam.IpVersion | Param IpVersion illegal. | 非法參數:IpVersion。 |
400 | OperationFailed.FilterParamUnderWrongRouteType | Operation failed because only custom type support filter by routeEntryId or routeEntryName | 操作失敗,只有自定義路由條目才支持通過路由條目id或路由條目名進行過濾 |
400 | IllegalParam.NextTokenExpired | The parameter of NextTokenExpired is illegal. | 參數NextTokenExpired非法。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-08-26 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-05 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-07-03 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |