功能介紹
查詢提交請(qǐng)求的租戶的所有網(wǎng)絡(luò)，單次查詢最多返回2000條數(shù)據(jù)，超過(guò)2000后會(huì)返回分頁(yè)標(biāo)記分頁(yè)。查詢請(qǐng)參考分頁(yè)查詢。
調(diào)試
您可以在API Explorer中調(diào)試該接口。
URI
GET /v2.0/networks
樣例：
GET https://{Endpoint}/v2.0/networks?id={network_id}&status={network_status}&name={network_name}&
admin_state_up=${admin_state_up}&tenant_id={tenant_id}&shared={is_shared}&provider:network_type={geneve}
分頁(yè)查詢樣例：
GET https://{Endpoint}/v2.0/networks?limit=2&marker=0133cd73-34d4-4d4c-bf1f-e65b24603206&page_reverse=False
參數(shù)說(shuō)明請(qǐng)參見(jiàn)表1。
|
名稱 |
是否必選 |
參數(shù)類型 |
說(shuō)明 |
|---|---|---|---|
|
id |
否 |
String |
按照網(wǎng)絡(luò)對(duì)應(yīng)的ID過(guò)濾查詢 |
|
name |
否 |
String |
按照網(wǎng)絡(luò)的名稱過(guò)濾查詢 |
|
admin_state_up |
否 |
Boolean |
按照網(wǎng)絡(luò)的管理狀態(tài)過(guò)濾查詢 取值范圍：true or false |
|
provider:network_type |
否 |
String |
按照網(wǎng)絡(luò)的類型過(guò)濾查詢 |
|
shared |
否 |
Boolean |
按照網(wǎng)絡(luò)是否支持跨租戶共享過(guò)濾查詢 取值范圍：true or false |
|
status |
否 |
String |
按照網(wǎng)絡(luò)的狀態(tài)過(guò)濾查詢 取值范圍：ACTIVE、BUILD、DOWN |
|
router:external |
否 |
Boolean |
按照網(wǎng)絡(luò)是否外部網(wǎng)絡(luò)過(guò)濾查詢 取值范圍：true or false |
|
tenant_id |
否 |
String |
按照網(wǎng)絡(luò)所屬的項(xiàng)目ID過(guò)濾查詢 |
|
marker |
否 |
String |
分頁(yè)查詢的起始資源ID，表示從指定資源的下一條記錄開(kāi)始查詢。 marker需要和limit配合使用：
|
|
limit |
否 |
Integer |
分頁(yè)查詢每頁(yè)返回的記錄個(gè)數(shù)，取值范圍為0~intmax（2^31-1），默認(rèn)值2000。 limit需要和marker配合使用，詳細(xì)規(guī)則請(qǐng)見(jiàn)marker的參數(shù)說(shuō)明。 |
請(qǐng)求參數(shù)
無(wú)。
請(qǐng)求示例
GET https://{Endpoint}/v2.0/networks?limit=1
響應(yīng)參數(shù)
|
參數(shù)名稱 |
類型 |
說(shuō)明 |
|---|---|---|
|
networks |
||
|
networks_links |
只有在使用limit過(guò)濾，并且資源個(gè)數(shù)超過(guò)limit或者資源個(gè)數(shù)超過(guò)2000時(shí)（limit默認(rèn)值），該參數(shù)的rel和href取值才會(huì)顯示為next和其對(duì)應(yīng)的link。 |
|
屬性 |
類型 |
說(shuō)明 |
|---|---|---|
|
status |
String |
網(wǎng)絡(luò)狀態(tài)，可以為ACTIVE，BUILD，DOWN或ERROR。 |
|
subnets |
Array of strings |
網(wǎng)絡(luò)關(guān)聯(lián)的子網(wǎng)ID。 一個(gè)network僅支持關(guān)聯(lián)一個(gè)subnet。 |
|
name |
String |
網(wǎng)絡(luò)名稱。 name不能為admin_external_net（預(yù)置網(wǎng)絡(luò)名稱，不可占用）。 |
|
router:external |
Boolean |
擴(kuò)展屬性：是否外部網(wǎng)絡(luò)，默認(rèn)值false。 |
|
admin_state_up |
Boolean |
管理狀態(tài)。 只支持true。 |
|
tenant_id |
String |
項(xiàng)目ID |
|
shared |
Boolean |
是否支持跨租戶共享。 |
|
id |
String |
網(wǎng)絡(luò)的id |
|
provider:network_type |
String |
擴(kuò)展屬性：網(wǎng)絡(luò)類型（支持vxlan，geneve）。 租戶只能指定此參數(shù)為geneve，不指定時(shí)網(wǎng)路類型自動(dòng)分配，一般分配為vxlan類型。 |
|
availability_zone_hints |
Array of strings |
本網(wǎng)絡(luò)的候選可用域，當(dāng)前版本不支持可用域調(diào)度。 |
|
availability_zones |
Array of strings |
本網(wǎng)絡(luò)的可用域。 |
|
port_security_enabled |
Boolean |
端口安全使能標(biāo)記，如果不使能，則network下所有虛機(jī)的安全組和dhcp防欺騙不生效 |
|
dns_domain |
String |
默認(rèn)內(nèi)網(wǎng)DNS域地址，系統(tǒng)自動(dòng)生成維護(hù)，不支持設(shè)置和更新 |
|
project_id |
String |
項(xiàng)目ID，請(qǐng)參見(jiàn)獲取項(xiàng)目ID。 |
|
created_at |
String |
資源創(chuàng)建時(shí)間，UTC時(shí)間 格式：yyyy-MM-ddTHH:mm:ss |
|
updated_at |
String |
資源更新時(shí)間，UTC時(shí)間 格式：yyyy-MM-ddTHH:mm:ss |
響應(yīng)示例
{
"networks": [
{
"id": "0133cd73-34d4-4d4c-bf1f-e65b24603206",
"name": "3804f26c-7862-43b6-ad3c-48445f42de89",
"status": "ACTIVE",
"shared": false,
"subnets": [
"423796f5-e02f-476f-bf02-2b88c8ddac8b"
],
"availability_zone_hints": [],
"availability_zones": [
"az2.dc2",
"az5.dc5"
],
"admin_state_up": true,
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"provider:network_type": "vxlan",
"router:external": false,
"port_security_enabled": true,
"created_at": "2018-03-23T03:51:58",
"updated_at": "2018-03-23T03:51:58"
}
],
"networks_links": [
{
"rel": "next",
"href": "https://{Endpoint}/v2.0/networks?limit=1&marker=0133cd73-34d4-4d4c-bf1f-e65b24603206"
},
{ "rel": "previous",
"href": "https://{Endpoint}/v2.0/subnets?limit=1&marker=
0133cd73-34d4-4d4c-bf1f-e65b24603206&page_reverse=True"
}
]
}
狀態(tài)碼
請(qǐng)參見(jiàn)狀態(tài)碼。
錯(cuò)誤碼
請(qǐng)參見(jiàn)錯(cuò)誤碼。
