Skip to main content

List

Retrieves the list of Registry resources in the specified folder.

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

const ListRegistriesRequest =
cloudApi.containerregistry.registry_service.ListRegistriesRequest;

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

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

ListRegistriesRequest

folderId : string

ID of the folder to list registries 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 ListRegistriesResponse.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 ListRegistriesResponse.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 Registry.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].

ListRegistriesResponse

registries : Registry

List of Registry 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 ListRegistriesRequest.page_size, use the next_page_token as the value for the ListRegistriesRequest.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.

Registry

A Registry resource. For more information, see the Registry section of the documentation.

Status
  • STATUS_UNSPECIFIED

  • CREATING

    Registry is being created.

  • ACTIVE

    Registry is ready to use.

  • DELETING

    Registry is being deleted.

id : string

Output only. ID of the registry.

folderId : string

ID of the folder that the registry belongs to.

name : string

Name of the registry.

status : Status

Output only. Status of the registry.

createdAt : google.protobuf.Timestamp

Output only. Creation timestamp in RFC3339 text format.

labels : string

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