華為云計(jì)算 云知識(shí) 查詢(xún)子網(wǎng)列表NeutronListSubnets
查詢(xún)子網(wǎng)列表NeutronListSubnets
時(shí)間: 2023-09-20 15:24:48
猜你想看：
實(shí)時(shí)語(yǔ)音識(shí)別 云服務(wù)器配置 CDN是什么意思 視頻點(diǎn)播加速 什么是云桌面

 

功能介紹

查詢(xún)提交請(qǐng)求的租戶的所有子網(wǎng)，單次查詢(xún)最多返回2000條數(shù)據(jù)，超過(guò)2000后會(huì)返回分頁(yè)標(biāo)記。分頁(yè)查詢(xún)請(qǐng)參考分頁(yè)查詢(xún)。

調(diào)試

您可以在API Explorer中調(diào)試該接口。

URI

GET /v2.0/subnets

樣例：

GET https://{Endpoint}/v2.0/subnets?name={subnet_name}&ip_version={ip_version}&
network_id={network_id}&cidr={subnet_cidr_address}&gateway_ip={subnet_gateway}&
tenant_id={tenant_id}&enable_dhcp={is_enable_dhcp}

分頁(yè)查詢(xún)樣例：

GET https://{Endpoint}/v2.0/subnets?limit=2&marker=011fc878-5521-4654-a1ad-f5b0b5820302&page_reverse=False

參數(shù)說(shuō)明請(qǐng)參見(jiàn)表1。

表1 參數(shù)說(shuō)明

名稱(chēng)

是否必選

參數(shù)類(lèi)型

說(shuō)明

id

否

String

按照子網(wǎng)對(duì)應(yīng)的ID過(guò)濾查詢(xún)

name

否

String

按照子網(wǎng)的名稱(chēng)過(guò)濾查詢(xún)

enable_dhcp

否

Boolean

按照子網(wǎng)是否開(kāi)啟dhcp過(guò)濾查詢(xún)

取值范圍：true or false

cidr

否

String

按照子網(wǎng)的cidr過(guò)濾查詢(xún)

network_id

否

String

按照子網(wǎng)所屬network_id過(guò)濾查詢(xún)

ip_version

否

String

按照子網(wǎng)的IP協(xié)議版本過(guò)濾查詢(xún)

gateway_ip

否

String

按照子網(wǎng)的網(wǎng)關(guān)IP過(guò)濾查詢(xún)

tenant_id

否

String

按照子網(wǎng)所屬的項(xiàng)目ID過(guò)濾查詢(xún)

marker

否

String

分頁(yè)查詢(xún)的起始資源ID，表示從指定資源的下一條記錄開(kāi)始查詢(xún)。

marker需要和limit配合使用：

  • 若不傳入marker和limit參數(shù)，查詢(xún)結(jié)果返回第一頁(yè)全部資源記錄。
  • 若不傳入marker參數(shù)，limit為10，查詢(xún)結(jié)果返回第1~10條資源記錄。
  • 若marker為第10條記錄的資源ID，limit為10，查詢(xún)結(jié)果返回第11~20條資源記錄。
  • 若marker為第10條記錄的資源ID，不傳入limit參數(shù)，查詢(xún)結(jié)果返回第11條及之后的所有資源記錄。

limit

否

Integer

分頁(yè)查詢(xún)每頁(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/subnets?limit=1

【示例二】

GET https://{Endpoint}/v2.0/subnets?id=011fc878-5521-4654-a1ad-f5b0b5820322

響應(yīng)參數(shù)

表2 響應(yīng)參數(shù)

參數(shù)名稱(chēng)

類(lèi)型

說(shuō)明

subnets

Array of subnet objects

subnet對(duì)象列表，參見(jiàn)表3。

subnets_links

Array of subnets_link objects

分頁(yè)信息，參見(jiàn)表6 。

只有在使用limit過(guò)濾，并且資源個(gè)數(shù)超過(guò)limit或者資源個(gè)數(shù)超過(guò)2000時(shí)（limit默認(rèn)值），該參數(shù)的rel和href取值才會(huì)顯示為next和其對(duì)應(yīng)的link。
表3 subnet對(duì)象

屬性

類(lèi)型

說(shuō)明

id

String

子網(wǎng)的id

【使用說(shuō)明】在查詢(xún)子網(wǎng)列表時(shí)非必選

name

String

子網(wǎng)的名稱(chēng)

ip_version

Integer

IP版本

【使用說(shuō)明】支持IPv4、IPv6

ipv6_address_mode

String

IPv6尋址模式

【使用說(shuō)明】?jī)H支持dhcpv6-stateful

ipv6_ra_mode

String

IPv6路由廣播模式

【使用說(shuō)明】?jī)H支持dhcpv6-stateful

network_id

String

所屬網(wǎng)絡(luò)的id

cidr

String

CIDR格式

【使用說(shuō)明】IPV4只支持10.0.0.0/8,172.16.0.0/12,192.168.0.0/16三個(gè)網(wǎng)段內(nèi)的地址，掩碼長(zhǎng)度不能大于28。

約束:當(dāng)ip_version=6時(shí),該字段不支持設(shè)置

gateway_ip

String

網(wǎng)關(guān)IP不允許和allocation_pools地址塊沖突。

【使用說(shuō)明】不支持修改。

allocation_pools

Array of allocation_pool objects

可用的IP池，allocation_pool對(duì)象參見(jiàn)表3 allocation_pool對(duì)象

例如：[ { "start": "10.0.0.2", "end": "10.0.0.251"} ]

每個(gè)子網(wǎng)的第1個(gè)和最后3個(gè)IP地址為系統(tǒng)保留地址。以192.168.1.0/24為例，192.168.1.0、 192.168.1.253、192.168.1.254和192.168.1.255這些地址是系統(tǒng)保留地址。

[{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}]

ipv6子網(wǎng)以2001:db8:a583:9::/64為例，2001:db8:a583:9::1和2001:db8:a583:9:ffff:ffff:ffff:fffd、2001:db8:a583:9:ffff:ffff:ffff:fffe、2001:db8:a583:9:ffff:ffff:ffff:ffff這些地址是系統(tǒng)保留地址。

系統(tǒng)預(yù)留地址默認(rèn)不在allocation_pool范圍內(nèi)。

約束：更新時(shí)allocation_pool范圍不能包含網(wǎng)關(guān)和廣播地址的所有IP。

dns_nameservers

Array of strings

dns服務(wù)器

例如："dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"]

host_routes

Array of host_route objects

虛擬機(jī)靜態(tài)路由，參見(jiàn)表5

【使用說(shuō)明】不支持，忽略輸入信息

tenant_id

String

項(xiàng)目ID

enable_dhcp

Boolean

是否啟動(dòng)dhcp，false表示不提供dhcp服務(wù)的能力

【使用說(shuō)明】只支持true

subnetpool_id

String

子網(wǎng)池id

【使用說(shuō)明】目前IPv4不支持，IPv6支持

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
表4 allocation_pool對(duì)象

參數(shù)名

參數(shù)類(lèi)型

備注

start

String

網(wǎng)絡(luò)池起始IP

end

String

網(wǎng)絡(luò)池結(jié)束IP
表5 host_route對(duì)象

參數(shù)名

參數(shù)類(lèi)型

備注

destination

String

路由目的子網(wǎng)

nexthop

String

路由下一跳IP
表6 subnets_link對(duì)象

參數(shù)名

參數(shù)類(lèi)型

備注

href

String

API鏈接

rel

String

API鏈接與該API版本的關(guān)系

響應(yīng)示例

【示例一】

{
    "subnets": [
        {
            "name": "kesmdemeet",
            "cidr": "172.16.236.0/24",
            "id": "011fc878-5521-4654-a1ad-f5b0b5820302",
            "enable_dhcp": true,
            "network_id": "48efad0c-079d-4cc8-ace0-dce35d584124",
            "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
            "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
            "dns_nameservers": [],
            "allocation_pools": [
                {
                    "start": "172.16.236.2",
                    "end": "172.16.236.251"
                }
            ],
            "host_routes": [],
            "ip_version": 4,
            "gateway_ip": "172.16.236.1",
            "created_at": "2018-03-26T08:23:43",
            "updated_at": "2018-03-26T08:23:44"
        }
    ],
    "subnets_links": [
       {
            "rel": "next", 
            "href": "https://{Endpoint}/v2.0/subnets?limit=1&marker=011fc878-5521-4654-a1ad-f5b0b5820302"
        }, 
       {    "rel": "previous", 
            "href": "https://{Endpoint}/v2.0/subnets?limit=1&marker=011fc878-5521-4654-a1ad-f5b0b5820302&
page_reverse=True"
        }
    ]
}

【示例二】 
{
    "subnets": [
        {
	    "id": "011fc878-5521-4654-a1ad-f5b0b5820322",
	    "name": "elb_alpha_vpc0_subnet0_172_16_0_0_24",
	    "tenant_id": "0c55e5b2b100d5202ff6c01a2fac4580",
	    "network_id": "3053b502-11b2-4599-bcf4-d9d06b6118b2",
            "ip_version": 6,
	    "cidr": "2001:db8:a583:a0::/64",
            "subnetpool_id": "cb03d100-8687-4c0a-9441-ea568dcae47d",
	    "allocation_pools": [{
	        "start": "2001:db8:a583:a0::2",
		"end": "2001:db8:a583:a0:ffff:ffff:ffff:fffc"
	    }],
	    "gateway_ip": "2001:db8:a583:a0::1",
	    "enable_dhcp": true,
	    "ipv6_ra_mode": "dhcpv6-stateful",
	    "ipv6_address_mode": "dhcpv6-stateful",
	    "description": "",
	    "dns_nameservers": [],
	    "host_routes": [],
	    "project_id": "0c55e5b2b100d5202ff6c01a2fac4580",
	    "created_at": "2021-07-01T07:59:28",
	    "updated_at": "2021-07-01T07:59:28"
        }
    ],
    "subnets_links": [
       {    "rel": "previous", 
            "href": "https://{Endpoint}/v2.0/subnets?limit=1&id=011fc878-5521-4654-a1ad-f5b0b5820322&
marker=011fc878-5521-4654-a1ad-f5b0b5820302&page_reverse=True"
        }
    ]
}

狀態(tài)碼

請(qǐng)參見(jiàn)狀態(tài)碼。

錯(cuò)誤碼

請(qǐng)參見(jiàn)錯(cuò)誤碼。

 

猜你喜歡
查詢(xún)子網(wǎng)列表NeutronListSubnets

意見(jiàn)反饋

0/200

提交 取消

提交成功！非常感謝您的反饋，我們會(huì)繼續(xù)努力做到更好 反饋提交失敗！請(qǐng)稍后重試！