功能介紹
查詢虛擬網(wǎng)關(guān)列表
調(diào)試
您可以在API Explorer中調(diào)試該接口，支持自動認證鑒權(quán)。API Explorer可以自動生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。
URI
GET /v3/{project_id}/dcaas/virtual-gateways
|
參數(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 |
返回結(jié)果按照升序(asc)或降序(desc)排列，默認為asc |
|
sort_key |
否 |
String |
排序字段。 缺省值：id 最小長度：0 最大長度：36 |
|
id |
否 |
Array |
根據(jù)資源ID過濾實例 數(shù)組長度：1 - 5 |
|
enterprise_project_id |
否 |
Array |
根據(jù)企業(yè)項目ID過濾資源實例 數(shù)組長度：1 - 10 |
|
vpc_id |
否 |
Array |
通過VPC-ID過慮虛擬網(wǎng)關(guān)實例 |
請求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。 獲取Token ，請參考《 統(tǒng)一身份認證 服務(wù)API參考》的“獲取用戶Token”章節(jié)。請求響應(yīng)成功后在響應(yīng)消息頭中包含的“X-Subject-Token”的值即為Token值。 最小長度：0 最大長度：10240 |
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
request_id |
String |
操作請求ID |
|
virtual_gateways |
虛擬網(wǎng)關(guān)對象列表 |
|
|
page_info |
分頁查詢頁的信息 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
虛擬網(wǎng)關(guān)的ID |
|
vpc_id |
String |
虛擬網(wǎng)關(guān)接入的VPC的ID |
|
tenant_id |
String |
實例所屬項目ID。 最小長度：32 最大長度：32 |
|
name |
String |
虛擬網(wǎng)關(guān)的名字 最小長度：0 最大長度：64 |
|
description |
String |
虛擬網(wǎng)關(guān)的描述 最小長度：0 最大長度：128 |
|
type |
String |
虛擬網(wǎng)關(guān)類型：default 缺省值：default |
|
local_ep_group |
Array of strings |
虛擬網(wǎng)關(guān)到訪問云上服務(wù)IPv4子網(wǎng)列表，通常是vpc的cidrs |
|
local_ep_group_ipv6 |
Array of strings |
預(yù)留字段用于虛擬網(wǎng)關(guān)到訪問云上服務(wù)IPv6子網(wǎng)列表，通常是vpc的cidrs |
|
admin_state_up |
Boolean |
管理狀態(tài)：true或false 缺省值：true |
|
status |
String |
操作狀態(tài)，合法值是：ACTIVE，DOWN，BUILD，ERROR，PENDING_CREATE，PENDING_UPDATE，PENDING_DELETE |
|
bgp_asn |
Integer |
虛擬網(wǎng)關(guān)本地的BGP自冶域號(asn) 最小值：1 最大值：4294967295 |
|
enterprise_project_id |
String |
實例所屬企業(yè)項目ID 最小長度：36 最大長度：36 |
|
tags |
標簽信息 數(shù)組長度：0 - 10 |
請求示例
查詢虛擬網(wǎng)關(guān)列表
GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways
響應(yīng)示例
狀態(tài)碼： 200
OK
{
"virtual_gateways" : [ {
"id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0",
"name" : "vgw-c7b22",
"description" : "",
"tenant_id" : "0605768a3300d5762f82c01180692873",
"vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
"type" : "default",
"status" : "ACTIVE",
"admin_state_up" : true,
"bgp_asn" : 64512,
"local_ep_group" : [ "192.168.1.0/24" ],
"enterprise_project_id" : "0"
} ],
"request_id" : "765f7aaf8f2edd0e719de564ef72e2de"
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
錯誤碼
請參見錯誤碼。
