功能介紹
查詢租戶所有的虛擬接口列表
調(diào)試
您可以在API Explorer中調(diào)試該接口，支持自動認證鑒權。API Explorer可以自動生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。
URI
GET /v3/{project_id}/dcaas/virtual-interfaces
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租戶項目ID |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
每頁返回的個數(shù)。 取值范圍：1~2000。 最小值：1 最大值：2000 缺省值：2000 |
|
marker |
否 |
String |
上一頁最后一條資源記錄的ID，為空時為查詢第一頁。 使用說明：必須與limit一起使用。 最小長度：0 最大長度：36 |
|
fields |
否 |
Array |
顯示字段列表 數(shù)組長度：1 - 5 |
|
sort_dir |
否 |
Array |
返回結果按照升序(asc)或降序(desc)排列，默認為asc |
|
sort_key |
否 |
String |
排序字段。 缺省值：id 最小長度：0 最大長度：36 |
|
enterprise_project_id |
否 |
Array |
根據(jù)企業(yè)項目ID過濾資源實例 數(shù)組長度：1 - 10 |
|
id |
否 |
Array |
根據(jù)資源ID過濾實例 數(shù)組長度：1 - 5 |
|
status |
否 |
Array |
根椐資源狀態(tài)過淲實例 數(shù)組長度：1 - 5 |
|
direct_connect_id |
否 |
Array |
根椐物理專線ID過濾查詢實例信息 數(shù)組長度：1 - 5 |
|
vgw_id |
否 |
Array |
根椐虛擬網(wǎng)關ID過濾查詢實例信息 數(shù)組長度：1 - 5 |
請求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。 獲取Token ，請參考《 統(tǒng)一身份認證 服務API參考》的“獲取用戶Token”章節(jié)。請求響應成功后在響應消息頭中包含的“X-Subject-Token”的值即為Token值。 最小長度：0 最大長度：10240 |
響應參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
request_id |
String |
操作請求ID |
|
virtual_interfaces |
虛擬接口對象 |
|
|
page_info |
分頁查詢頁的信息 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
虛擬接口的ID 最大長度：36 |
|
name |
String |
虛擬接口的名字 最大長度：64 |
|
admin_state_up |
Boolean |
管理狀態(tài)：true或false |
|
bandwidth |
Integer |
虛擬接口接入帶寬 最小值：2 最大值：2147483647 |
|
create_time |
String |
虛擬接口創(chuàng)建時間 最大長度：255 |
|
update_time |
String |
虛擬接口更新時間 |
|
description |
String |
虛擬接口的描述 最大長度：128 |
|
direct_connect_id |
String |
物理專線的ID 最大長度：36 |
|
service_type |
String |
接入網(wǎng)關的類型：包括VGW,GDGW,LGW等 枚舉值：
|
|
status |
String |
操作狀態(tài)，合法值是：ACTIVE，DOWN，BUILD，ERROR，PENDING_CREATE，PENDING_UPDATE，PENDING_DELETE，DELETED，AUTHORIZATION，REJECTED |
|
tenant_id |
String |
租戶ID 最小長度：32 最大長度：32 |
|
type |
String |
表示接口類型：private 缺省值：private 最大長度：255 枚舉值：
|
|
vgw_id |
String |
虛擬網(wǎng)關的ID 最小長度：36 最大長度：36 |
|
vlan |
Integer |
同用戶網(wǎng)關對接的vlan, 配置范圍0-3999 最小值：0 最大值：3999 |
|
route_limit |
Integer |
VIF遠端子網(wǎng)路由配置規(guī)格 最小值：1 最大值：200 缺省值：50 |
|
enable_nqa |
Boolean |
是否使能nqa功能：true或false |
|
enable_bfd |
Boolean |
是否使能nqa功能：true或false |
|
lag_id |
String |
VIF關聯(lián)的鏈路聚合組ID 最小長度：36 最大長度：36 |
|
device_id |
String |
歸屬的設備ID |
|
enterprise_project_id |
String |
實例所屬企業(yè)項目ID 最小長度：36 最大長度：36 |
|
tags |
標簽信息 數(shù)組長度：0 - 10 |
|
|
vif_peers |
vif的Peer的相關信息 |
|
|
extend_attribute |
接口BFD/NQA等可靠性檢測信息,只有配置BFD和NQA的擴展參數(shù)才會顯示擴展參數(shù)信息 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
key |
String |
標簽鍵，最大長度36個unicode字符，格式為大小寫字母，數(shù)字，中劃線“-”，下劃線“_”，中文。 最小長度：0 最大長度：36 |
|
value |
String |
標簽值，最大長度43個unicode字符，格式為大小寫字母，數(shù)字，中劃線“-”，下劃線“_”，點“.”，中文。 最小長度：0 最大長度：43 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
資源ID 最小長度：36 最大長度：36 |
|
tenant_id |
String |
歸屬租戶ID 最小長度：36 最大長度：36 |
|
name |
String |
VIF對等體名字 最小長度：0 最大長度：64 |
|
description |
String |
VIF對等體名字描述信息 最小長度：0 最大長度：128 |
|
address_family |
String |
接口的地址簇類型，ipv4，ipv6 |
|
local_gateway_ip |
String |
VIF對等體云側接口地址 |
|
remote_gateway_ip |
String |
VIF對等體客戶側接口地址 |
|
route_mode |
String |
路由模式：static/bgp 最大長度：255 枚舉值：
|
|
bgp_asn |
Integer |
BGP鄰居的AS號 最小值：1 最大值：4294967295 |
|
bgp_md5 |
String |
BGP鄰居的MD5密碼 |
|
remote_ep_group |
Array of strings |
遠端子網(wǎng)列表，記錄租戶側的cidrs |
|
service_ep_group |
Array of strings |
該字段用于公網(wǎng)專線接口,表示租戶可以訪問云上公網(wǎng)服務地址列表 |
|
device_id |
String |
歸屬的設備ID |
|
bgp_route_limit |
Integer |
BGP的路由配置規(guī)格 |
|
bgp_status |
String |
接口BGP協(xié)議狀態(tài),如果是靜態(tài)路由接口則狀態(tài)為 null 最大長度：10 |
|
status |
String |
VIF對等體狀態(tài) |
|
vif_id |
String |
vif對等體對應的虛擬接口ID 最小長度：36 最大長度：36 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
ha_type |
String |
虛擬接口的可用性檢測類型 枚舉值：
|
|
ha_mode |
String |
檢測的具體的配置模式 枚舉值：
|
|
detect_multiplier |
Integer |
檢測的重試次數(shù) 缺省值：5 |
|
min_rx_interval |
Integer |
檢測的接收時長間隔 缺省值：1000 |
|
min_tx_interval |
Integer |
檢測的發(fā)送時長間隔 缺省值：1000 |
|
remote_disclaim |
Integer |
檢測的遠端的標識，用于靜態(tài)BFD |
|
local_disclaim |
Integer |
檢測的本端的標識，用于靜態(tài)BFD |
請求示例
查詢虛擬接口列表
GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces
響應示例
狀態(tài)碼： 200
OK
{
"virtual_interfaces" : [ {
"id" : "0d0fdf63-f2c4-491c-8866-d504796189be",
"name" : "vif-0819",
"description" : "mytest",
"tenant_id" : "0605768a3300d5762f82c01180692873",
"direct_connect_id" : "4673e339-8412-4ee1-b73e-2ba9cdfa54c1",
"vgw_id" : "8a47064a-f34c-4f94-b7fe-cac456c9b37b",
"type" : "private",
"service_type" : "VGW",
"vlan" : 332,
"bandwidth" : 2,
"status" : "ACTIVE",
"create_time" : "2022-08-19T11:28:06.000Z",
"admin_state_up" : true,
"enable_bfd" : false,
"route_limit" : 50,
"enable_nqa" : false,
"vif_peers" : [ {
"id" : "c768eb52-12a8-4859-9b43-81194643040c",
"tenant_id" : "0605768a3300d5762f82c01180692873",
"name" : "vif-0819",
"description" : "",
"address_family" : "ipv4",
"local_gateway_ip" : "1.1.1.1/30",
"remote_gateway_ip" : "1.1.1.2/30",
"route_mode" : "static",
"bgp_asn" : null,
"bgp_md5" : null,
"device_id" : "18.9.215.131",
"bgp_route_limit" : 100,
"bgp_status" : null,
"status" : "ACTIVE",
"vif_id" : "0d0fdf63-f2c4-491c-8866-d504796189be",
"remote_ep_group" : [ "1.1.2.0/30" ],
"service_ep_group" : null
} ],
"enterprise_project_id" : "0"
} ],
"request_id" : "5633df7af874576d819a481c76673236"
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
錯誤碼
請參見錯誤碼。
