查询虚拟子网详情 - ShowVirsubnet
功能介绍
当您的子网创建成功后,您可以通过调用该接口查询单个子网的详细信息,包括子网的名称、ID、状态等。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
vpc:subnets:get
Read
subnet *
-
g:ResourceTag/<tag-key>
-
vpc:SubnetId
-
vpc:VpcId
-
vpc:AvailabilityZone
-
g:EnterpriseProjectId
-
-
-
URI
GET /v3/{project_id}/vpc/virsubnets/{virsubnet_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 子网所属的项目ID。获取方式请参见获取项目ID。 取值范围: 不涉及。 |
| virsubnet_id | 是 | String | 参数解释: 子网的资源ID。 取值范围: 不涉及。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| request_id | String | 参数解释: 请求ID。 取值范围: 不涉及。 |
| virsubnet | Virsubnet object | 参数解释: 查询子网详情的响应体。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 | 参数解释: 子网的状态。 取值范围:
|
| project_id | String | 参数解释: 子网所属的项目ID。 取值范围: 不涉及。 |
| scope | String | 参数解释: 子网的作用域(边缘云场景)。 取值范围:
|
| 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。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: OpenStack Neutron子网的资源ID。 取值范围: 带“-”的标准UUID格式。 |
| ip_version | String | 参数解释: OpenStack Neutron子网的IP版本。 取值范围:
|
| 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功能。 取值范围:
|
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 标签键。 取值范围:
|
| value | String | 参数解释: 标签值。 取值范围:
|
| 参数 | 参数类型 | 描述 |
|---|---|---|
| opt_name | String | 参数解释: 子网配置的NTP地址、DNS域名或租约到期时间的名称。 取值范围:
|
| opt_value | String | 参数解释: 子网配置的NTP地址、DNS域名或租约到期时间。 取值范围:
|
| ip_version | Integer | 参数解释: 子网的IP版本。 取值范围:
|
请求示例
查询子网详情。
GET https://{Endpoint}/v3/{project_id}/vpc/virsubnets/fafb85b7-3b32-c8a8-53d7-84740c40ac1d 响应示例
状态码:200
GET操作正常返回,更多状态码请参见状态码。
{
"virsubnet" : {
"name" : "subnet-test",
"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" : ""
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | GET操作正常返回,更多状态码请参见状态码。 |
错误码
请参见错误码。