文档首页/ 数据安全中心 DSC/ API参考/ API/ 基础设施查询/ 获取vpc子网列表 - ListSubnets
更新时间:2026-11-13 GMT+08:00
分享

获取vpc子网列表 - ListSubnets

功能介绍

功能介绍:获取vpc子网列表

调用方法

请参见如何调用API。

授权信息

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

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/sdg/asset/vpc/{vpc_id}/subnet

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,标识当前请求所属的华为云项目,可参考获取项目ID相关文档获取

约束限制:

满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字

取值范围:

长度为32个字符,只能由小写英文字母和数字组成

默认取值:

不涉及

vpc_id

是

String

参数解释:

虚拟私有云ID,标识一个VPC,可通过VPC服务查询VPC列表接口获取或在虚拟私有云控制台获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

subnets

Array of Subnet objects

参数解释:

子网列表

取值范围:

不涉及

subnet

Subnet object

参数解释:

子网

取值范围:

不涉及

表4 Subnet

参数

参数类型

描述

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

name

String

参数解释:

子网名称

取值范围:

不涉及

status

String

参数解释:

操作结果状态

取值范围:

不涉及

gateway_ip

String

参数解释:

网关IP地址

取值范围:

不涉及

gateway_ip_v6

String

参数解释:

IPv6网关IP

取值范围:

不涉及

network_id

String

参数解释:

网络ID,标识子网所属的网络

取值范围:

不涉及

vpc_id

String

参数解释:

虚拟私有云ID

取值范围:

不涉及

cidr

String

参数解释:

CIDR网段

取值范围:

不涉及

dhcp_enable

Boolean

参数解释:

动态主机配置协议启用状态

取值范围:

true-是,false-否

primary_dns

String

参数解释:

主DNS

取值范围:

不涉及

secondary_dns

String

参数解释:

辅DNS

取值范围:

不涉及

availability_zone

String

参数解释:

可用区,标识资源部署所在的可用区

取值范围:

不涉及

dns_list

Array of strings

参数解释:

DNS列表

取值范围:

不涉及

dnsList

Array of strings

参数解释:

DNS列表(适配老版前端字段)

取值范围:

不涉及

ipv6_enable

Boolean

参数解释:

是否启用IPv6

取值范围:

true-是,false-否

cidr_v6

String

参数解释:

IPv6无类别域际路由(CIDR)

取值范围:

不涉及

neutron_subnet_id

String

参数解释:

子网ID

取值范围:

不涉及

neutron_subnet_id_v6

String

参数解释:

IPv6子网ID

取值范围:

不涉及

请求示例

获取vpc子网列表

/v1/2b31ed5200000ebedb6e570000000000/sdg/asset/vpc/a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d/subnet

响应示例

状态码:200

{
  "subnets" : [ {
    "id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
    "name" : "asset-resource-01",
    "status" : "ENABLE",
    "gateway_ip" : "192.168.1.100",
    "gateway_ip_v6" : "2001:db8::1",
    "network_id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
    "vpc_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
    "cidr" : "192.168.0.0/16",
    "dhcp_enable" : true,
    "primary_dns" : "8.8.8.8",
    "secondary_dns" : "114.114.114.114",
    "availability_zone" : "cn-north-4a",
    "dns_list" : [ "8.8.8.8", "114.114.114.114" ],
    "dnsList" : [ "8.8.8.8", "114.114.114.114" ],
    "ipv6_enable" : true,
    "cidr_v6" : "2001:db8::/32",
    "neutron_subnet_id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70",
    "neutron_subnet_id_v6" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档