華為云計算 云知識 查詢VPC路由列表ListVpcRoutes
查詢VPC路由列表ListVpcRoutes

 

功能介紹

查詢提交請求的租戶的所有路由列表,并根據過濾條件進行過濾。分頁查詢響應格式請參考分頁查詢。

調試

您可以在API Explorer中調試該接口。

URI

GET /v2.0/vpc/routes

樣例:

樣例:
GET https://{Endpoint}/v2.0/vpc/routes?id={id}&vpc_id={vpc_id}&
tenant_id={tenant_id}&destination={destination}&type={type}&limit={limit}&marker={marker}
參數說明請參見表1。
表1 參數說明

名稱

是否必選

參數類型

說明

id

String

按照routes_id過濾查詢

tenant_id

String

按照tenant_id過濾查詢

vpc_id

String

按照vpc_id過濾查詢

destination

String

按照路由目的地址CIDR過濾查詢

type

String

按照type進行過濾查詢,目前只支持peering

marker

String

分頁查詢的起始資源ID,表示從指定資源的下一條記錄開始查詢。

marker需要和limit配合使用:

  • 若不傳入marker和limit參數,查詢結果返回第一頁全部資源記錄。
  • 若不傳入marker參數,limit為10,查詢結果返回第1~10條資源記錄。
  • 若marker為第10條記錄的資源ID,limit為10,查詢結果返回第11~20條資源記錄。
  • 若marker為第10條記錄的資源ID,不傳入limit參數,查詢結果返回第11條及之后的所有資源記錄。

limit

Integer

分頁查詢每頁返回的記錄個數,取值范圍為0~intmax(2^31-1),默認值2000。

limit需要和marker配合使用,詳細規(guī)則請見marker的參數說明。

默認值為2000。

請求參數

請求示例

GET https://{Endpoint}/v2.0/vpc/routes?vpc_id=ab78be2d-782f-42a5-aa72-35879f6890ff

響應參數

表2 響應參數

參數名稱

類型

說明

routes

Array of route objects

route對象列表,參見表3。

routes_links

Array of routes_link objects

routes_link對象列表,參見表4。

只有在使用limit過濾,并且資源個數超過limit或者資源個數超過2000時(limit默認值),該參數的rel和href取值才會顯示為next和其對應的link。

表3 route對象

屬性

類型

說明

id

String

路由id

destination

String

路由目的地址CIDR,如192.168.200.0/24。

nexthop

String

路由下一跳,如果路由是“peering”類型,填寫vpc peering id。

type

String

路由類型。目前只支持“peering”。

vpc_id

String

路由的vpc,需要填寫存在的vpc_id。

tenant_id

String

項目ID

表4 routes_link對象

名稱

參數類型

說明

href

String

API鏈接

rel

String

API鏈接與該API版本的關系

響應示例

{ 
  "routes": [ 
    { 
      "type": "peering",  
      "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9",  
      "destination": "192.168.200.0/24",  
      "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff",  
      "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
      "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" 
    }
  ] 
}

狀態(tài)碼

請參見狀態(tài)碼。

錯誤碼

請參考錯誤碼。