功能介紹
查詢 企業(yè)路由器 列表
接口約束
-
分頁(yè)查詢使用的參數(shù)為marker、limit。marker和limit一起使用時(shí)才會(huì)生效，單獨(dú)使用無(wú)效。
-
支持單字段排序，排序字段有[id,name,description,created_at,updated_at]，不支持多字段排序。
調(diào)試
您可以在API Explorer中調(diào)試該接口，支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。
URI
GET /v3/{project_id}/enterprise-router/instances
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項(xiàng)目ID |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
每頁(yè)返回的個(gè)數(shù)。 取值范圍：0~2000。 最小值：0 最大值：2000 |
|
marker |
否 |
String |
查詢的頁(yè)碼id，為空時(shí)為查詢第一頁(yè)。 使用說(shuō)明：必須與limit一起使用。 最小長(zhǎng)度：1 最大長(zhǎng)度：128 |
|
enterprise_project_id |
否 |
Array |
企業(yè)項(xiàng)目ID |
|
state |
否 |
Array |
企業(yè)路由器實(shí)例狀態(tài) |
|
id |
否 |
Array |
根據(jù)資源ID查詢，可同時(shí)查詢多個(gè)。 |
|
resource_id |
否 |
Array |
連接對(duì)應(yīng)的資源ID列表 |
|
owned_by_self |
否 |
Boolean |
過(guò)濾資源是否屬于當(dāng)前租戶；取值為true時(shí)，只查屬于當(dāng)前租戶的資源，不包括共享資源；為false時(shí)，查詢當(dāng)前租戶及共享給該租戶的資源； |
|
sort_key |
否 |
Array |
按關(guān)鍵字排序，默認(rèn)按照id排序，可選值:id|name|state |
|
sort_dir |
否 |
Array |
返回結(jié)果按照升序或降序排列，默認(rèn)為asc,降序?yàn)閐esc |
請(qǐng)求參數(shù)
無(wú)
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
instances |
企業(yè)路由器列表 |
|
|
page_info |
分頁(yè)查詢的信息 |
|
|
request_id |
String |
請(qǐng)求ID |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
企業(yè)路由器實(shí)例的ID |
|
name |
String |
企業(yè)路由器實(shí)例名稱 |
|
description |
String |
企業(yè)路由器實(shí)例描述信息 |
|
state |
String |
運(yùn)行狀態(tài) |
|
tags |
標(biāo)簽信息 |
|
|
charge_mode |
String |
計(jì)費(fèi)模式 按需 缺省值：postPaid |
|
created_at |
String |
創(chuàng)建時(shí)間 |
|
updated_at |
String |
更新時(shí)間 |
|
enterprise_project_id |
String |
企業(yè)項(xiàng)目ID |
|
project_id |
String |
項(xiàng)目ID |
|
asn |
Long |
企業(yè)路由器實(shí)例的BGP AS號(hào) |
|
enable_default_propagation |
Boolean |
是否開(kāi)啟默認(rèn)路由表傳播，默認(rèn)false不開(kāi)啟 |
|
enable_default_association |
Boolean |
是否開(kāi)啟默認(rèn)路由表關(guān)聯(lián)，默認(rèn)false不開(kāi)啟 |
|
default_propagation_route_table_id |
String |
默認(rèn)傳播路由表id |
|
default_association_route_table_id |
String |
默認(rèn)關(guān)聯(lián)路由表id |
|
availability_zone_ids |
Array of strings |
企業(yè)路由器所在可用區(qū)信息 |
|
auto_accept_shared_attachments |
Boolean |
是否自動(dòng)接受共享連接創(chuàng)建，默認(rèn)false不開(kāi)啟 |
請(qǐng)求示例
-
分頁(yè)查詢2兩條記錄
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/instances?limit=2&marker=1 -
全量查詢
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/instances
響應(yīng)示例
狀態(tài)碼： 200
OK
{
"instances" : [ {
"id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff",
"name" : "my_er",
"description" : "this is my first enterprise router",
"asn" : 64512,
"project_id" : "08d5a9564a704afda6039ae2babbef3c",
"enable_default_association" : true,
"enable_default_propagation" : true,
"default_association_route_table_id" : "7f7f738f-453c-40b1-be26-28e7b9e390c1",
"default_propagation_route_table_id" : "7f7f738f-453c-40b1-be26-28e7b9e390c1",
"auto_accept_shared_attachments" : false,
"created_at" : "2019-09-06 02:11:13Z",
"updated_at" : "2019-09-06 02:11:13Z",
"tags" : [ {
"key" : "key",
"value" : "value"
} ],
"enterprise_project_id" : 0,
"availability_zone_ids" : [ "az1", "az2" ]
} ],
"request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9",
"page_info" : {
"next_marker" : "2",
"current_count" : 1
}
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
錯(cuò)誤碼
請(qǐng)參見(jiàn)錯(cuò)誤碼。
