文档首页/ 虚拟私有云 VPC/ API参考/ API V3/ 虚拟子网/ 查询虚拟子网列表 - ListVirsubnets
更新时间:2025-12-08 GMT+08:00
分享

查询虚拟子网列表 - ListVirsubnets

功能介绍

当您的子网创建成功后,您可以通过调用该接口查询所有子网信息,包括子网的名称、ID等。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    vpc:subnets:list

    List

    subnet *

    -

    • vpc:subnets:get

    -

    -

    g:EnterpriseProjectId

URI

GET /v3/{project_id}/vpc/virsubnets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

子网所属的项目ID。获取方式请参见获取项目ID

取值范围

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释

每页返回的资源个数。

取值范围

0~2000。

marker

String

参数解释

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

取值范围

子网的资源ID。

id

Array of strings

参数解释

子网的资源ID,填写后按照ID进行过滤,支持传入多个ID过滤。

取值范围

不涉及。

name

Array of strings

参数解释

子网的名称,填写后按照名称进行过滤,支持传入多个名称过滤。

取值范围

不涉及。

vpc_id

Array of strings

参数解释

子网所在VPC的资源ID,填写后按照VPC资源ID进行过滤,支持传入多个ID过滤。

取值范围

不涉及。

status

String

参数解释

子网的状态,填写后按照状态进行过滤,只支持传入单个状态过滤。

取值范围

  • ACTIVE:表示子网已挂载到VPC上。

  • UNKNOWN:表示子网还未挂载到VPC上。

  • ERROR:表示子网状态故障。

scope

Array of strings

参数解释

子网的作用域,填写后按照作用域进行过滤,支持传入多个作用域过滤。

取值范围

  • center:表示作用域为中心。

  • {publicBorderGroup}:表示作用域为具体的公网边界组。公网边界组限制子网的可用区范围,可关联多个边缘可用区。

zone_id

Array of strings

参数解释

子网的可用区ID,填写后按照可用区ID进行过滤,支持传入多个可用区ID过滤。

取值范围

不涉及

description

Array of strings

参数解释

子网的描述信息,填写后按照描述信息进行过滤,支持传入多个描述信息过滤。

取值范围

不涉及。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

request_id

String

参数解释

请求ID。

取值范围

不涉及。

virsubnets

Array of Virsubnet objects

参数解释

查询子网列表的响应体。

取值范围

不涉及。

page_info

PageInfo object

参数解释

分页信息。

取值范围

不涉及。

表4 Virsubnet

参数

参数类型

描述

id

String

参数解释

子网的资源ID。子网创建成功后,会生成一个子网 ID,是子网对应的唯一标识。

取值范围

带“-”的标准UUID格式。

name

String

参数解释

子网的名称。

取值范围

1-64个字符,支持数字、字母、中文字符、_(下划线)、-(中划线)、.(点)。

description

String

参数解释

子网的描述信息。

取值范围

0-255个字符,不能包含“<”和“>”。

dns_nameservers

Array of strings

参数解释

子网的DNS服务器地址列表。

取值范围

不涉及。

zone_id

String

参数解释

子网的可用区ID。

取值范围

不涉及。

vpc_id

String

参数解释

子网所属VPC的资源ID。

取值范围

不涉及。

status

String

参数解释

子网的状态。

取值范围

  • ACTIVE:表示子网已挂载到VPC上。

  • UNKNOWN:表示子网还未挂载到VPC上。

  • ERROR:表示子网状态故障。

project_id

String

参数解释

子网所属的项目ID。

取值范围

不涉及。

scope

String

参数解释

子网的作用域(边缘云场景)。

取值范围

  • center:表示作用域为中心。

  • {publicBorderGroup}:表示作用域为具体的公网边界组。公网边界组限制子网的可用区范围,可关联多个边缘可用区。

subnet_cidrs

Array of SubnetCidr objects

参数解释

OpenStack Neutron子网信息。

取值范围

不涉及。

tags

Array of ResponseTag objects

参数解释

子网的标签信息,包括标签键和标签值,可用来分类和标识资源。详情请参见Tag对象。

取值范围

不涉及。

extra_dhcp_opts

Array of SubnetExtraDhcpOpt objects

参数解释

子网的DHCP属性,支持配置NTP地址、DNS域名或租约到期时间。

取值范围

不涉及。

created_at

String

参数解释

子网的创建时间。

取值范围

UTC时间格式,yyyy-MM-ddTHH:mm:ss。

updated_at

String

参数解释

子网的更新时间。

取值范围

UTC时间格式,yyyy-MM-ddTHH:mm:ss。

表5 SubnetCidr

参数

参数类型

描述

id

String

参数解释

OpenStack Neutron子网的资源ID。

取值范围

带“-”的标准UUID格式。

ip_version

String

参数解释

OpenStack Neutron子网的IP版本。

取值范围

  • 4:IPv4子网。

  • 6:IPv6子网。

cidr

String

参数解释

OpenStack Neutron子网的IP网段。

取值范围

CIDR格式,如IPv4网段:192.168.23.0/24,IPv6网段:2420:2023:410:d5d::/64。

gateway_ip

String

参数解释

OpenStack Neutron子网的网关IP地址。

取值范围

不涉及。

enable_dhcp

Boolean

参数解释

OpenStack Neutron子网是否开启DHCP功能。

取值范围

  • true:开启DHCP功能。

  • false:未开启DHCP功能。

表6 ResponseTag

参数

参数类型

描述

key

String

参数解释

标签键。

取值范围

  • 最大长度128个unicode字符, key不能为空。

  • 同一资源的key不能重复。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、点(.)、冒号(:)、加号(+)、中划线(-)、等号(=)

    • 中文字符

value

String

参数解释

标签值。

取值范围

  • 每个值最大长度255个unicode字符,value可以为空。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、点(.)、冒号(:)、加号(+)、中划线(-)、等号(=)

    • 中文字符

表7 SubnetExtraDhcpOpt

参数

参数类型

描述

opt_name

String

参数解释

子网配置的NTP地址、DNS域名或租约到期时间的名称。

取值范围

  • 42:表示子网ntp地址。

  • 15:表示DNS配置的域名,用于向DNS服务器获取IP地址。

  • 51:表示IPv4子网租约到期时间。

  • 651:表示IPv6子网租约到期时间。

opt_value

String

参数解释

子网配置的NTP地址、DNS域名或租约到期时间。

取值范围

  • opt_name配置为“42”,则表示是子网ntp地址,目前只支持IPv4地址,每个IP地址以逗号隔开,IP地址个数不能超过4个,不能存在相同地址。

  • opt_name配置为“15”,则该值表示是DNS配置的域名,用于向DNS服务器获取IP地址。域名只能由字母,数字,中划线组成,中划线不能在开头或末尾。域名可以包含多个字符串,单个字符串不超过63个字符,字符串间以点分隔。域名长度不超过254个字符。

  • opt_name配置为“51”,则该值表示是IPv4子网租约到期时间,取值格式有两种,取-1,表示无限租约;数字+h,数字范围是1~175200,比如5h,默认值为87600h。

  • opt_name配置为“651”,则该值表示是IPv6子网租约到期时间,取值格式有两种,取-1,表示无限租约;数字+h,数字范围是1~175200,比如5h,默认值为2h。

ip_version

Integer

参数解释

子网的IP版本。

取值范围

  • 4:默认值,IPv4。

  • 6:IPv6,只有opt_name是“651”时,ip_version为6。

表8 PageInfo

参数

参数类型

描述

previous_marker

String

参数解释

当前页的第一条记录。

取值范围

不涉及。

current_count

Integer

参数解释

当前页的资源总数。

取值范围

不涉及。

next_marker

String

参数解释

当前页的最后一条记录,最后一页时无next_marker字段。

取值范围

不涉及。

请求示例

查询子网列表。

GET https://{Endpoint}/v3/{project_id}/vpc/virsubnets

响应示例

状态码:200

GET操作正常返回,更多状态码请参见状态码

{
  "request_id" : "83ce7c3aebc450bc40316e5856eff16e",
  "virsubnets" : [ {
    "name" : "subnet-1",
    "id" : "26c31230-6c2e-4dc3-b423-97ea75abac7c",
    "project_id" : "11e8dd119c77479db890e266e68c1ecf",
    "status" : "ACTIVE",
    "tags" : [ ],
    "description" : "",
    "created_at" : "2025-11-26T07:21:25",
    "updated_at" : "2025-12-05T09:11:19",
    "subnet_cidrs" : [ {
      "id" : "0ab40e38-edd2-46ff-bfec-d092d417275b",
      "ip_version" : "4",
      "cidr" : "192.168.23.0/24",
      "gateway_ip" : "192.168.23.1",
      "enable_dhcp" : true
    }, {
      "id" : "37fcba97-5fab-4328-906e-fc2b3f261796",
      "ip_version" : "6",
      "cidr" : "2420:2023:410:d5d::/64",
      "gateway_ip" : "2420:2023:410:d5d::1",
      "enable_dhcp" : true
    } ],
    "dns_nameservers" : [ "100.125.3.250", "100.125.3.251" ],
    "vpc_id" : "1e8a8ea6-c641-4461-810c-5851868f98be",
    "extra_dhcp_opts" : [ {
      "opt_value" : "10.0.0.1,10.0.0.2",
      "opt_name" : "42",
      "ip_version" : 4
    }, {
      "opt_value" : "2h",
      "opt_name" : "651",
      "ip_version" : 6
    }, {
      "opt_value" : "87600h",
      "opt_name" : "51",
      "ip_version" : 4
    }, {
      "opt_value" : "domain.com",
      "opt_name" : "15",
      "ip_version" : 4
    } ],
    "scope" : "center",
    "zone_id" : ""
  }, {
    "name" : "subnet-2",
    "id" : "518a60c6-06a1-427c-88b7-3e4fc98e2998",
    "project_id" : "11e8dd119c77479db890e266e68c1ecf",
    "status" : "ACTIVE",
    "tags" : [ {
      "key" : "a",
      "value" : "a"
    } ],
    "description" : "",
    "created_at" : "2025-11-14T03:57:02",
    "updated_at" : "2025-11-14T03:57:02",
    "subnet_cidrs" : [ {
      "id" : "eded5d66-4f57-4f9e-82f9-26796b00c526",
      "ip_version" : "4",
      "cidr" : "192.168.12.0/24",
      "gateway_ip" : "192.168.12.1",
      "enable_dhcp" : true
    } ],
    "dns_nameservers" : [ "100.125.3.250", "100.125.3.251" ],
    "vpc_id" : "a45cbb45-a36c-4d49-8616-0517aa158b14",
    "extra_dhcp_opts" : [ {
      "opt_value" : "87600h",
      "opt_name" : "51",
      "ip_version" : 4
    } ],
    "scope" : "center",
    "zone_id" : ""
  } ],
  "page_info" : {
    "previous_marker" : "26c31230-6c2e-4dc3-b423-97ea75abac7c",
    "current_count" : 2
  }
}

状态码

状态码

描述

200

GET操作正常返回,更多状态码请参见状态码

错误码

请参见错误码

相关文档