List

Retrieves the list of Network resources in the specified folder.

TypeScript

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListNetworksRequest = cloudApi.vpc.network_service.ListNetworksRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.NetworkServiceClient);

  const result = await client.list(
    ListNetworksRequest.fromPartial({
      folderId: "folderId",
      // pageSize: 0,
      // pageToken: "pageToken",
      // filter: "filter"
    })
  );
  console.log(result);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.vpc.v1.network_service_pb2 import ListNetworksRequest
from yandex.cloud.serverless.functions.v1.network_service_pb2_grpc import NetworkServiceStub

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(NetworkServiceStub)
response = service.List(
    ListNetworksRequest(
        folder_id="folderId",
        # page_size = 0,
        # page_token = "pageToken",
        # filter = "filter"
    )
)
print(response)

ListNetworksRequest

folderId : string

ID of the folder to list networks in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.

pageSize : 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 ListNetworksResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100.

pageToken : string

Page token. To get the next page of results, set page_token to the ListNetworksResponse.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 the Network.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].

ListNetworksResponse

networks : Network

List of Network resources.

nextPageToken : string

This token allows you to get the next page of results for list requests. If the number of results is larger than ListNetworksRequest.page_size, use the next_page_token as the value for the ListNetworksRequest.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.

Network

A Network resource. For more information, see Networks.

id : string

ID of the network.

folderId : string

ID of the folder that the network belongs to.

createdAt : google.protobuf.Timestamp

Creation timestamp in RFC3339 text format.

name : string

Name of the network. The name is 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 network. 0-256 characters long.

labels : string

Resource labels as 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]*.

defaultSecurityGroupId : string

ID of default security group for network.

---