文档首页/ 虚拟私有云 VPC/ API参考/ API/ 子网/ 查询子网
更新时间：2024-10-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询子网

功能介绍

查询子网。

调试

您可以在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

是否开启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

子网所在的可用区标识

vpc_id

String

子网所在VPC标识

status

String
  • 功能说明：子网的状态。
  • 取值范围：ACTIVE,UNKNOWN,ERROR
    • ACTIVE表示子网已挂载到VPC上
    • UNKNOWN表示子网还未挂载到VPC上
    • ERROR表示子网状态故障

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}：表示作用域为具体的可用区

tenant_id

String

功能说明：项目ID。

created_at

String
  • 功能说明：资源创建时间，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"
    }
}

状态码

请参见状态码。

错误码

请参考错误码。

父主题： 子网

相关文档