List

Retrieves the list of Folder resources in the specified cloud.

TypeScript

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

const ListFoldersRequest =
  cloudApi.resourcemanager.folder_service.ListFoldersRequest;

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

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.resourcemanager.v1.folder_service_pb2_grpc import FolderServiceStub
from yandex.cloud.resourcemanager.v1.folder_service_pb2 import ListFoldersRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(FolderServiceStub)
response = service.List(
    ListFoldersRequest(
        cloud_id="cloudId",
        # page_size = 0,
        # page_token = "pageToken",
        # filter = "filter"
    )
)
print(response)

ListFoldersRequest

cloudId : string

ID of the cloud to list folders in. To get the cloud ID, use a yandex.cloud.resourcemanager.v1.CloudService.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 ListFoldersResponse.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. Set page_token to the ListFoldersResponse.next_page_token returned by a previous list request to get the next page of results.

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 Folder.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].

ListFoldersResponse

folders : Folder

List of Folder 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 ListFoldersRequest.page_size, use the next_page_token as the value for the ListFoldersRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Folder

A Folder resource. For more information, see Folder.

Status

• STATUS_UNSPECIFIED

• ACTIVE

  The folder is active.

• DELETING

  The folder is being deleted.

• PENDING_DELETION

  Stopping folder resources and waiting for the deletion start timestamp.

id : string

ID of the folder.

cloudId : string

ID of the cloud that the folder belongs to.

createdAt : google.protobuf.Timestamp

Creation timestamp.

name : string

Name of the folder. The name is unique within the cloud. 3-63 characters long.

description : string

Description of the folder. 0-256 characters long.

labels : string

Resource labels as key:value pairs. Maximum of 64 per resource.

status : Status

Status of the folder.

---