Contact UsGet started

Virtual Private Cloud API, gRPC: SubnetService.List

Written by
Updated at December 17, 2024

Retrieves the list of Subnet resources in the specified folder.

gRPC request

rpc List (ListSubnetsRequest) returns (ListSubnetsResponse)

ListSubnetsRequest

{
  "folder_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string"
}

Field

Description

folder_id

string

Required field. ID of the folder to list subnets in.
To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request.

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size,
the service returns a ListSubnetsResponse.next_page_token
that can be used to get the next page of results in subsequent list requests. Default value: 100.

page_token

string

Page token. To get the next page of results, set page_token to the
ListSubnetsResponse.next_page_token returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.
The expression must specify:

  1. The field name. Currently you can use filtering only on Subnet.name field.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].

ListSubnetsResponse

{
  "subnets": [
    {
      "id": "string",
      "folder_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "labels": "map<string, string>",
      "network_id": "string",
      "zone_id": "string",
      "v4_cidr_blocks": [
        "string"
      ],
      "v6_cidr_blocks": [
        "string"
      ],
      "route_table_id": "string",
      "dhcp_options": {
        "domain_name_servers": [
          "string"
        ],
        "domain_name": "string",
        "ntp_servers": [
          "string"
        ]
      }
    }
  ],
  "next_page_token": "string"
}

Field

Description

subnets[]

Subnet

List of Subnet resources.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListSubnetsRequest.page_size, use
the next_page_token as the value
for the ListSubnetsRequest.page_token query parameter
in the next list request. Subsequent list requests will have their own
next_page_token to continue paging through the results.

Subnet

A Subnet resource. For more information, see Subnets.

Field

Description

id

string

ID of the subnet.

folder_id

string

ID of the folder that the subnet belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format.

name

string

Name of the subnet.
The name must be unique within the folder.
Value must match the regular expression \\|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.

description

string

Optional description of the subnet. 0-256 characters long.

labels

object (map<string, string>)

Resource labels, key:value pairs.
No more than 64 per resource.
The maximum string length in characters for each value is 63.
Each value must match the regular expression [-_0-9a-z]*.
The string length in characters for each key must be 1-63.
Each key must match the regular expression [a-z][-_0-9a-z]*.

network_id

string

ID of the network the subnet belongs to.

zone_id

string

ID of the availability zone where the subnet resides.

v4_cidr_blocks[]

string

CIDR block.
The range of internal addresses that are defined for this subnet.
This field can be set only at Subnet resource creation time and cannot be changed.
For example, 10.0.0.0/22 or 192.168.0.0/24.
Minimum subnet size is /28, maximum subnet size is /16.

v6_cidr_blocks[]

string

IPv6 not available yet.

route_table_id

string

ID of route table the subnet is linked to.

dhcp_options

DhcpOptions

DHCP options for the subnet.

DhcpOptions

Field

Description

domain_name_servers[]

string

A list of DHCP servers for this subnet.

domain_name

string

A domain name to us as a suffix when resolving host names in this subnet.

ntp_servers[]

string

List of NTP servers for this subnet.
Previous
Get
Next
Create