Querying Subnet Details
Function
This API is used to query details about a subnet.
URI
GET /v1/{project_id}/subnets/{subnet_id}
Table 1 describes the parameters.
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. |
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"}}
Status Code
See Status Codes.
Error Code
See Error Codes.
- Function
- URI
- Request Parameters
- Example Request
- Response Parameters
- Example Response
- Status Code
- Error Code