華為云計(jì)算 云知識(shí) 查詢(xún)子網(wǎng)列表ListSubnets
查詢(xún)子網(wǎng)列表ListSubnets

 

功能介紹

查詢(xún)子網(wǎng)列表。

調(diào)試

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

URI

GET /v1/{project_id}/subnets

樣例:
GET https://{Endpoint}/v1/{project_id}/subnets?limit=10&
marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85
表1 參數(shù)說(shuō)明

名稱(chēng)

是否必選

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

說(shuō)明

project_id

String

項(xiàng)目ID,獲取項(xiàng)目ID請(qǐng)參見(jiàn)獲取項(xiàng)目ID。

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ō)明。

vpc_id

String

按照vpc_id過(guò)濾查詢(xún)

企業(yè)項(xiàng)目細(xì)粒度授權(quán)場(chǎng)景下,該字段必傳

請(qǐng)求參數(shù)

無(wú)

請(qǐng)求示例

GET https://{Endpoint}/v1/{project_id}/subnets

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

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

名稱(chēng)

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

說(shuō)明

subnets

Array of subnet objects

subnet對(duì)象列表

表3 subnet對(duì)象

名稱(chēng)

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

說(shuō)明

id

String

uuid形式的一個(gè)資源標(biāo)識(shí)。

name

String

  • 功能說(shuō)明:子網(wǎng)名稱(chēng)
  • 取值范圍:1-64個(gè)字符,支持?jǐn)?shù)字、字母、中文、_(下劃線)、-(中劃線)、.(點(diǎn))

description

String

  • 功能說(shuō)明:子網(wǎng)描述
  • 取值范圍:0-255個(gè)字符,不能包含“<”和“>”。

cidr

String

子網(wǎng)的網(wǎng)段

gateway_ip

String

子網(wǎng)的網(wǎng)關(guān)

ipv6_enable

Boolean

是否創(chuàng)建IPv6子網(wǎng)

cidr_v6

String

IPv6子網(wǎng)的網(wǎng)段,如果子網(wǎng)為IPv4子網(wǎng),則不返回此參數(shù)

gateway_ip_v6

String

IPv6子網(wǎng)的網(wǎng)關(guān),如果子網(wǎng)為IPv4子網(wǎng),則不返回此參數(shù)

dhcp_enable

Boolean

子網(wǎng)是否開(kāi)啟dhcp功能

primary_dns

String

子網(wǎng)dns服務(wù)器地址1

secondary_dns

String

子網(wǎng)dns服務(wù)器地址2

dnsList

Array of strings

子網(wǎng)dns服務(wù)器地址列表集

availability_zone

String

子網(wǎng)所在的可用區(qū)標(biāo)識(shí)

vpc_id

String

子網(wǎng)所在VPC標(biāo)識(shí)

status

String

  • 功能說(shuō)明:子網(wǎng)的狀態(tài)。
  • 取值范圍:ACTIVE,UNKNOWN,ERROR
    • ACTIVE表示子網(wǎng)已掛載到VPC上
    • UNKNOWN表示子網(wǎng)還未掛載到VPC上
    • ERROR表示子網(wǎng)狀態(tài)故障

neutron_network_id

String

對(duì)應(yīng)網(wǎng)絡(luò)(OpenStack Neutron接口)id

neutron_subnet_id

String

對(duì)應(yīng)子網(wǎng)(OpenStack Neutron接口)id

neutron_subnet_id_v6

String

對(duì)應(yīng)IPv6子網(wǎng)(OpenStack Neutron接口)id,如果子網(wǎng)為IPv4子網(wǎng),則不返回此參數(shù)

extra_dhcp_opts

Array of extra_dhcp_opt objects

子網(wǎng)配置的NTP地址或租約時(shí)間,詳情請(qǐng)參見(jiàn)extra_dhcp_opt對(duì)象。

scope

String

子網(wǎng)作用域。

取值范圍:

  • center:表示作用域?yàn)橹行?/li>
  • {azId}:表示作用域?yàn)榫唧w的可用區(qū)

tenant_id

String

功能說(shuō)明:項(xiàng)目ID。

created_at

String

  • 功能說(shuō)明:資源創(chuàng)建時(shí)間,UTC時(shí)間
  • 格式:yyyy-MM-ddTHH:mm:ss

updated_at

String

  • 功能說(shuō)明:資源更新時(shí)間,UTC時(shí)間
  • 格式:yyyy-MM-ddTHH:mm:ss
表4 extra_dhcp_opt對(duì)象

名稱(chēng)

是否必選

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

說(shuō)明

opt_value

String

  • 功能說(shuō)明:子網(wǎng)配置的NTP地址或子網(wǎng)配置的租約到期時(shí)間。
  • 約束:

    opt_name配置為“ntp”,則表示是子網(wǎng)ntp地址,目前只支持IPv4地址,每個(gè)IP地址以逗號(hào)隔開(kāi),IP地址個(gè)數(shù)不能超過(guò)4個(gè),不能存在相同地址。該字段為null表示取消該子網(wǎng)NTP的設(shè)置,不能為“ ”(空字符串)。

    opt_name配置為“addresstime”,則該值表示是子網(wǎng)租約到期時(shí)間,取值格式有兩種,取-1,表示無(wú)限租約;數(shù)字+h,數(shù)字范圍是1~30000,比如5h,默認(rèn)值為24h。

opt_name

String

  • 功能說(shuō)明:子網(wǎng)配置的NTP地址名稱(chēng)或子網(wǎng)配置的租約到期名稱(chēng)。
  • 約束:目前只支持填寫(xiě)字符串“ntp”或“addresstime”。

響應(yīng)示例

{
    "subnets": [
        {
            "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d",
            "name": "subnet",
            "description": "",
            "cidr": "192.168.20.0/24",
            "dnsList": [
                "114.xx.xx.114",
                "114.xx.xx.115"
            ],
            "status": "ACTIVE",
            "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
            "gateway_ip": "192.168.20.1",
            "ipv6_enable": true, 
            "cidr_v6": "2001:db8:a583::/64", 
            "gateway_ip_v6": "2001:db8:a583::1",
            "dhcp_enable": true,
            "primary_dns": "114.xx.xx.114",
            "secondary_dns": "114.xx.xx.115",
            "availability_zone": "aa-bb-cc",
            "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d",
            "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12",
            "neutron_subnet_id_v6": "e0fa7de1-a6e2-44c9-b052-b9d8cebe93c4",
            "extra_dhcp_opts": [
              {
                "opt_value": "10.100.0.33,10.100.0.34",
                "opt_name": "ntp"
              },
              {
                "opt_value": "24h",
                "opt_name": "addresstime"
              }
           ],
            "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
            "created_at": "2022-12-15T02:42:07",
            "updated_at": "2022-12-15T02:42:07"
        },
        {
            "id": "531dec0f-3116-411b-a21b-e612e42349fd",
            "name": "Subnet1",
            "description": "",
            "cidr": "192.168.1.0/24",
            "dnsList": [
                "114.xx.xx.114",
                "114.xx.xx.115"
            ],
            "status": "ACTIVE",
            "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
            "gateway_ip": "192.168.1.1",
            "ipv6_enable": false,
            "dhcp_enable": true,
            "primary_dns": "114.xx.xx.114",
            "secondary_dns": "114.xx.xx.115",
            "availability_zone": "aa-bb-cc",
            "neutron_network_id": "531dec0f-3116-411b-a21b-e612e42349fd",
            "neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78",
            "extra_dhcp_opts": [
              {
                "opt_value": "10.100.0.33,10.100.0.34",
                "opt_name": "ntp"
              },
              {
                "opt_value": "24h",
                "opt_name": "addresstime"
              }
           ],
            "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
            "created_at": "2022-12-15T03:41:22",
            "updated_at": "2022-12-15T03:41:22"
        }
    ]
}

狀態(tài)碼

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

錯(cuò)誤碼

請(qǐng)參考錯(cuò)誤碼。