• Virtual Private Cloud

vpc
  1. Help Center
  2. Virtual Private Cloud
  3. API Reference
  4. APIs
  5. Subnet
  6. Querying Subnets

Querying Subnets

Function

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

URI

GET /v1/{project_id}/subnets

Example:
/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.

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

int

  • 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

    None

Response Message

  • Response parameter
    Table 2 Response parameter

    Name

    Type

    Description

    subnets

    List data structure

    Specifies the subnet list objects.

    Table 3 Description of the subnets field

    Name

    Type

    Description

    id

    String

    Specifies a resource ID in UUID format.

    name

    String

    Specifies the subnet name.

    cidr

    String

    Specifies the subnet network segment.

    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

    List

    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 the router.
      • UNKNOWN: indicates that the subnet has not been associated with the router.
      • ERROR: indicates that the subnet is abnormal.

    extra_dhcp_opts

    List

    Specifies the NTP server address configured for the subnet. For details, see the extra_dhcp_opt object.

    Table 4 extra_dhcp_opt object

    Name

    Mandatory

    Type

    Description

    opt_value

    No

    String

    • Specifies the NTP server address configured for the subnet.
    • Constraints:

      The option ntp for opt_name indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option null for opt_name indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string.

    opt_name

    Yes

    String

    • Specifies the NTP server address name configured for the subnet.
    • Currently, the value can only be set to ntp.
  • 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",
                "extra_dhcp_opts": [
                  {
                    "opt_value": "10.100.0.33,10.100.0.34",
                    "opt_name": "ntp"
                  }
               ]
            },
            {
                "id": "531dec0f-3116-411b-a21b-e612e42349fd",
                "name": "Subnet1",
                "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",
                "extra_dhcp_opts": [
                  {
                    "opt_value": "10.100.0.33,10.100.0.34",
                    "opt_name": "ntp"
                  }
               ]
            }
        ]
    }

Status Codes

For details, see section Status Codes.

Error Codes

For details, see section Error Codes.