華為云計算 云知識 查詢子網ShowSubnet
查詢子網ShowSubnet

 

功能介紹

查詢子網。

調試

您可以在API Explorer中調試該接口。

URI

GET /v1/{project_id}/subnets/{subnet_id}

參數說明請參見表1。
表1 參數說明

名稱

是否必選

說明

project_id

項目ID,獲取項目ID請參見獲取項目ID

subnet_id

子網唯一標識。

如果您使用管理控制臺,此值即為子網詳情中的“網絡ID”參數值。

請求參數

請求示例

GET https://{Endpoint}/v1/{project_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d

響應參數

表2 響應參數

名稱

參數類型

說明

subnet

subnet object

subnet對象

表3 subnet對象

名稱

參數類型

說明

id

String

uuid形式的一個資源標識。

name

String

  • 功能說明:子網名稱
  • 取值范圍:1-64個字符,支持數字、字母、中文、_(下劃線)、-(中劃線)、.(點)

description

String

  • 功能說明:子網描述
  • 取值范圍:0-255個字符,不能包含“<”和“>”。

cidr

String

子網的網段

gateway_ip

String

子網的網關

ipv6_enable

Boolean

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

cidr_v6

String

IPv6子網的網段,如果子網為IPv4子網,則不返回此參數

gateway_ip_v6

String

IPv6子網的網關,如果子網為IPv4子網,則不返回此參數

dhcp_enable

Boolean

子網是否開啟dhcp功能

primary_dns

String

子網dns服務器地址1

secondary_dns

String

子網dns服務器地址2

dnsList

Array of strings

子網dns服務器地址列表集

availability_zone

String

子網所在的可用區(qū)標識

vpc_id

String

子網所在VPC標識

status

String

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

neutron_network_id

String

對應網絡(OpenStack Neutron接口)id

neutron_subnet_id

String

對應子網(OpenStack Neutron接口)id

neutron_subnet_id_v6

String

對應IPv6子網(OpenStack Neutron接口)id,如果子網為IPv4子網,則不返回此參數

extra_dhcp_opts

Array of extra_dhcp_opt objects

子網配置的NTP地址或租約時間,詳情請參見extra_dhcp_opt對象。

scope

String

子網作用域。

取值范圍:

  • center:表示作用域為中心
  • {azId}:表示作用域為具體的可用區(qū)

tenant_id

String

功能說明:項目ID。

created_at

String

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

updated_at

String

  • 功能說明:資源更新時間,UTC時間
  • 格式:yyyy-MM-ddTHH:mm:ss
表4 extra_dhcp_opt對象

名稱

是否必選

參數類型

說明

opt_value

String

  • 功能說明:子網配置的NTP地址或子網配置的租約到期時間。
  • 約束:

    opt_name配置為“ntp”,則表示是子網ntp地址,目前只支持IPv4地址,每個IP地址以逗號隔開,IP地址個數不能超過4個,不能存在相同地址。該字段為null表示取消該子網NTP的設置,不能為“ ”(空字符串)。

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

opt_name

String

  • 功能說明:子網配置的NTP地址名稱或子網配置的租約到期名稱。
  • 約束:目前只支持填寫字符串“ntp”或“addresstime”。

響應示例

{
    "subnet": {
        "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": false,
        "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",
        "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"
    }
}

狀態(tài)碼

請參見狀態(tài)碼

錯誤碼

請參考錯誤碼。