Updated on 2022-01-25 GMT+08:00

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.
Table 1 Parameter description

Name

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 Message

  • Request parameter

    None

  • Example request
    GET https://{Endpoint}/v1/{project_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d

Response Message

  • Response parameter
    Table 2 Response parameter

    Name

    Type

    Description

    subnet

    Object

    Specifies the subnet objects.

    Table 3 subnet objects

    Name

    Type

    Description

    id

    String

    Specifies a resource ID in UUID format.

    name

    String

    • Specifies the subnet name.
    • The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), hyphens (-), and periods (.).

    description

    String

    • Provides supplementary information about the subnet.
    • The value is a string of no more than 255 characters and cannot contain angle brackets (< or >).

    cidr

    String

    Specifies the subnet CIDR block.

    gateway_ip

    String

    Specifies the subnet gateway address.

    dhcp_enable

    Boolean

    Specifies whether DHCP is enabled for the subnet.

    primary_dns

    String

    Specifies the IP address of DNS server 1 on the subnet.

    secondary_dns

    String

    Specifies the IP address of DNS server 2 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

    • Specifies the status of the subnet.
    • The value can be ACTIVE, UNKNOWN, or ERROR.
      • ACTIVE: indicates that the subnet has been associated with a VPC.
      • UNKNOWN: indicates that the subnet has not been associated with a VPC.
      • ERROR: indicates that the subnet is abnormal.

    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).

  • 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",
            "dhcp_enable": true,
            "primary_dns": "114.xx.xx.114",
            "secondary_dns": "114.xx.xx.115",
            "availability_zone": "aa-bb-cc",//For example, the AZ is 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.