目前該API接口已標記為棄用,推薦使用替代API:Vpc(2016-04-28) - DescribeRouteTableList。
調用DescribeRouteTables接口查詢路由表。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vpc:DescribeRouteTables | list | *RouteTable acs:vpc:{#regionId}:{#accountId}:routetable/{#RouteTableId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 要查詢的路由表所屬的 VPC 的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | ap-southeast-6 |
VRouterId | string | 否 | 要查詢的路由器的 ID。 說明
VRouterId,RouteTableId,RouterId 和 RouteTableName 參數至少需要輸入一個,但是不能同時輸入 VRouterId 和 RouterId 參數。
| vrt-bp1lhl0taikrteen**** |
RouteTableId | string | 否 | 要查詢的路由表的 ID。 說明
VRouterId,RouteTableId,RouterId 和 RouteTableName 參數至少需要輸入一個,但是不能同時輸入 VRouterId 和 RouterId 參數。
| vtb-bp145q7glnuzdvzu2**** |
RouterType | string | 否 | 要查詢的路由表所屬的路由器的類型。取值:
| VRouter |
RouterId | string | 否 | 要查詢的路由表所屬路由器的 ID。 說明
VRouterId,RouteTableId,RouterId 和 RouteTableName 參數至少需要輸入一個,但是不能同時輸入 VRouterId 和 RouterId 參數。
| vrt-bp1lhl0taikrteen8**** |
Type | string | 否 | 要查詢的路由條目的類型。取值:
| Custom |
RouteTableName | string | 否 | 要查詢的路由表的名稱。 名稱長度為 2~128 個字符,必須以字母或中文開頭,可包含數字、半角句號(.)、下劃線(_)和短劃線(-)。 說明
VRouterId,RouteTableId,RouterId 和 RouteTableName 參數至少需要輸入一個,但是不能同時輸入 VRouterId 和 RouterId 參數。
| doctest |
ResourceGroupId | string | 否 | 要查詢的路由表所屬資源組的 ID。 | rg-acfmxazb4ph**** |
PageNumber | integer | 否 | 列表的頁碼,默認值為 1。 | 1 |
PageSize | integer | 否 | 分頁查詢時每頁的行數,最大值為 50,默認值為 10。 | 10 |
返回參數
示例
正常返回示例
JSON
格式
{
"PageSize": 10,
"RequestId": "DC668356-BCB4-42FD-9BC3-FA2B2E04B634",
"PageNumber": 1,
"TotalCount": 1,
"RouteTables": {
"RouteTable": [
{
"CreationTime": "2022-08-22T10:40:25Z",
"Status": "Available",
"VRouterId": "vrt-bp1lhl0taikrteen****",
"RouteTableType": "Custom",
"ResourceGroupId": "rg-acfmxazb4ph****",
"RouteTableId": "vtb-bp145q7glnuzdvzu2****",
"RouteEntrys": {
"RouteEntry": [
{
"Type": "Custom",
"Status": "Available",
"NextHopType": "Instance",
"RouteEntryName": "name",
"RouteEntryId": "rte-bp1mnnr2al0naomnp****",
"InstanceId": "vpc-bp1t36rn9l53iwbsf****",
"RouteTableId": "vtb-bp15w5q90d2rk3bww****",
"Description": "RouteEntryDescription",
"DestinationCidrBlock": "192.168.2.0/24",
"NextHops": {
"NextHop": [
{
"NextHopId": "vpn-bp10zyaph5cc8b7c7****",
"Weight": 100,
"NextHopType": "Instance",
"Enabled": 1
}
]
}
}
]
},
"VSwitchIds": {
"VSwitchId": [
"vsw-bp12mw1f8k3jgygk9****"
]
}
}
]
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidVRouterId.NotFound | Specified virtual router does not exist. | 該路由器不存在,請您檢查輸入的路由器是否正確。 |
400 | OperationFailed.DescribeCenRoute | An error occurred while querying the CEN route entry. | 查詢cen路由異常。 |
400 | OperationFailed.VRouterNotExist | Operation failed because the VRouter does not exist. | 操作失敗因為虛擬路由器不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-06-12 | OpenAPI 變更為 deprecated,即將下線、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-09-25 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-09-06 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-08-09 | OpenAPI 描述信息更新 | 查看變更詳情 |