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

Querying Subnets

Function

This API is used to query subnets using search criteria and to display the subnets in a list.

URI

GET /v1/{project_id}/subnets

Example:
GET https://{Endpoint}/v1/{project_id}/subnets?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85
Table 1 Parameter description

Name

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

marker

No

String

Specifies the start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.

limit

No

Integer

  • Specifies the number of records returned on each page.
  • The value ranges from 0 to intmax.

vpc_id

No

String

Specifies that the VPC ID is used as the filtering condition.

Request Message

  • Request parameter

    None

  • Example request
    GET https://{Endpoint}/v1/{project_id}/subnets

Response Message

  • Response parameter
    Table 2 Response parameter

    Name

    Type

    Description

    subnets

    Array of subnets objects

    Specifies the subnets objects.

    Table 3 subnets 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 the DHCP function 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
    {
        "subnets": [
            {
                "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d",
                "name": "subnet",
                "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"
            },
            {
                "id": "531dec0f-3116-411b-a21b-e612e42349fd",
                "name": "Subnet1",
                "description": "",
                "cidr": "192.168.1.0/24",
                "dnsList": [
                    "114.xx.xx.114",
                    "114.xx.xx.115"
                ],
                "status": "ACTIVE",
                "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
                "gateway_ip": "192.168.1.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": "531dec0f-3116-411b-a21b-e612e42349fd",
                "neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78"
            }
        ]
    }

Status Code

See Status Codes.

Error Code

See Error Codes.