更新时间:2022-01-25 GMT+08:00

查询子网列表

功能介绍

查询子网列表。

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 参数说明

名称

是否必选

参数类型

说明

project_id

String

项目ID,获取项目ID请参见获取项目ID

marker

String

分页查询起始的资源id,为空时为查询第一页

limit

Integer

  • 功能说明:每页返回的个数
  • 取值范围:0~intmax

vpc_id

String

按照vpc_id过滤查询

请求消息

  • 请求参数

  • 请求样例
    GET https://{Endpoint}/v1/{project_id}/subnets

响应消息

  • 响应参数
    表2 响应参数

    名称

    参数类型

    说明

    subnets

    Array of subnets objects

    subnets对象

    表3 subnets对象

    名称

    参数类型

    说明

    id

    String

    uuid形式的一个资源标识。

    name

    String

    • 功能说明:子网名称
    • 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

    description

    String

    • 功能说明:子网描述
    • 取值范围:0-255个字符,不能包含“<”和“>”。

    cidr

    String

    子网的网段

    gateway_ip

    String

    子网的网关

    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

  • 响应样例
    {
        "subnets": [
            {
                "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d",
                "name": "subnet",
                "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",
                "dhcp_enable": true,
                "primary_dns": "114.xx.xx.114",
                "secondary_dns": "114.xx.xx.115",
                "availability_zone": "aa-bb-cc",//假设可用区名称为aa-bb-cc。
                "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d",
                "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12"
            },
            {
                "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",
                "dhcp_enable": true,
                "primary_dns": "114.xx.xx.114",
                "secondary_dns": "114.xx.xx.115",
                "availability_zone": "aa-bb-cc",//假设可用区名称为aa-bb-cc。
                "neutron_network_id": "531dec0f-3116-411b-a21b-e612e42349fd",
                "neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78"
            }
        ]
    }

状态码

请参见状态码

错误码

请参考错误码