Querying Subnet Details
Function
This API is used to query details about a subnet.
URI
GET /v1/{project_id}/subnets/{subnet_id}
Parameter |
Mandatory |
Description |
---|---|---|
project_id |
Yes |
Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. |
subnet_id |
Yes |
Specifies the subnet ID, which uniquely identifies the subnet. If you use the management console, the value of this parameter is the Network ID value. |
Request Parameters
None
Example Request
GET https://{Endpoint}/v1/{project_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d
Response Parameters
Parameter |
Type |
Description |
---|---|---|
subnet |
subnet object |
Specifies the subnet objects. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies a resource ID in UUID format. |
name |
String |
|
description |
String |
|
cidr |
String |
Specifies the subnet CIDR block. |
gateway_ip |
String |
Specifies the subnet gateway address. |
ipv6_enable |
Boolean |
Specifies whether IPv6 is enabled. |
cidr_v6 |
String |
Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. |
gateway_ip_v6 |
String |
Specifies the IPv6 subnet gateway. If the subnet is an IPv4 subnet, this parameter is not returned. |
dhcp_enable |
Boolean |
Specifies whether DHCP is enabled for the subnet. |
primary_dns |
String |
Specifies the primary IP address of DNS server on the subnet. |
secondary_dns |
String |
Specifies the standby IP address of DNS server on the subnet. |
dnsList |
Array of strings |
Specifies the IP address list of DNS servers on the subnet. |
availability_zone |
String |
Identifies the AZ to which the subnet belongs. |
vpc_id |
String |
Specifies the ID of the VPC to which the subnet belongs. |
status |
String |
|
neutron_network_id |
String |
Specifies the ID of the corresponding network (OpenStack Neutron API). |
neutron_subnet_id |
String |
Specifies the ID of the corresponding subnet (OpenStack Neutron API). |
neutron_subnet_id_v6 |
String |
Specifies the ID of the IPv6 subnet (OpenStack Neutron API). If the subnet is an IPv4 subnet, this parameter is not returned. |
extra_dhcp_opts |
Array of extra_dhcp_opt objects |
Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see Table 4. |
scope |
String |
|
tenant_id |
String |
Project ID |
created_at |
String |
|
updated_at |
String |
|
Example Response
{ "subnet": { "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "name": "subnet", "description": "", "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", "ipv6_enable": false, "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", "availability_zone": "aa-bb-cc", "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" } ], "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T02:42:07", "updated_at": "2022-12-15T02:42:07" } }
Status Code
See Status Codes.
Error Code
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot