虚拟私有云 VPC虚拟私有云 VPC

更新时间:2021/07/11 GMT+08:00
分享

查询子网列表

功能介绍

查询提交请求的租户的所有子网,单次查询最多返回2000条数据,超过2000后会返回分页标记。分页查询请参考分页查询

调试

您可以在API Explorer中直接运行调试该接口。

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}

分页查询样例:

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

参数说明请参见表1

表1 参数说明

名称

是否必选

参数类型

说明

id

String

按照子网对应的ID过滤查询

name

String

按照子网的名称过滤查询

enable_dhcp

Boolean

按照子网是否开启dhcp过滤查询

取值范围:true or false

cidr

String

按照子网的cidr过滤查询

network_id

String

按照子网所属network_id过滤查询

ip_version

String

按照子网的IP协议版本过滤查询

gateway_ip

String

按照子网的网关IP过滤查询

tenant_id

String

按照子网所属的项目ID过滤查询

marker

String

分页查询的起始资源ID,表示从指定资源的下一条记录开始查询。

marker需要和limit配合使用:

  • 若不传入marker和limit参数,查询结果返回全部资源记录。
  • 若不传入marker参数,limit为10,查询结果返回第1~10条资源记录。
  • 若marker为第10条记录的资源ID,limit为10,查询结果返回第11~20条资源记录。
  • 若marker为第10条记录的资源ID,不传入limit参数,查询结果返回第11条及之后的所有资源记录。

limit

Integer

分页查询每页返回的记录个数,取值范围为0~intmax。

limit需要和marker配合使用,详细规则请见marker的参数说明。

请求消息

无。

响应消息

表2 响应参数

参数名称

类型

说明

subnets

Array of subnet objects

subnet对象列表,参见表3

subnets_links

Array of subnets_link objects

分页信息,参见表6

表3 subnet对象

属性

类型

说明

id

String

子网的id

【使用说明】在查询子网列表时非必选

name

String

子网的名称

ip_version

Integer

IP版本

【使用说明】只支持IPv4

ipv6_address_mode

String

IPv6寻址模式

ipv6_ra_mode

String

IPv6路由广播模式

network_id

String

所属网络的id

cidr

String

CIDR格式

【使用说明】只支持10.0.0.0/8,172.16.0.0/12,192.168.0.0/16三个网段内的地址,掩码长度不能大于28。

gateway_ip

String

网关IP不允许和allocation_pools地址块冲突。

【使用说明】不支持修改。

allocation_pools

Array of allocation_pool objects

可用的IP池,allocation_pool对象参见表3 allocation_pool对象

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

每个子网的第1个和最后3个IP地址为系统保留地址。以192.168.1.0/24为例,192.168.1.0、 192.168.1.253、192.168.1.254和192.168.1.255这些地址是系统保留地址。系统预留地址默认不在allocation_pool范围内。

约束:更新时allocation_pool范围不能包含网关和广播地址的所有IP。

dns_nameservers

Array of strings

dns服务器

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

host_routes

Array of host_route objects

虚拟机静态路由,参见表5

【使用说明】不支持,忽略输入信息

tenant_id

String

项目ID

enable_dhcp

Boolean

是否启动dhcp,false表示不提供dhcp服务的能力

【使用说明】只支持true

project_id

String

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

created_at

String

资源创建时间,UTC时间

格式:yyyy-MM-ddTHH:mm:ss

updated_at

String

资源更新时间,UTC时间

格式:yyyy-MM-ddTHH:mm:ss

表4 allocation_pool对象

参数名

参数类型

备注

start

String

网络池起始IP

end

String

网络池结束IP

表5 host_route对象

参数名

参数类型

备注

destination

String

路由目的子网

nexthop

String

路由下一跳IP

表6 subnets_link对象

参数名

参数类型

备注

href

String

API链接

rel

String

API链接与该API版本的关系

样例

请求样例

GET https://{Endpoint}/v2.0/subnets?limit=1

响应样例

{
    "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"
        }
    ]
}

状态码

请参见状态码

错误码

请参见错误码

分享:

    相关文档

    相关产品