Contact UsGet started

Container Registry API, gRPC: RegistryService.List

Written by
Updated at December 17, 2024

Retrieves the list of Registry resources in the specified folder.

gRPC request

rpc List (ListRegistriesRequest) returns (ListRegistriesResponse)

ListRegistriesRequest

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

Field

Description

folder_id

string

Required field. ID of the folder to list registries 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 ListRegistriesResponse.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
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": [
    {
      "id": "string",
      "folder_id": "string",
      "name": "string",
      "status": "Status",
      "created_at": "google.protobuf.Timestamp",
      "labels": "map<string, string>"
    }
  ],
  "next_page_token": "string"
}

Field

Description

registries[]

Registry

List of Registry 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 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.

Field

Description

id

string

Output only. ID of the registry.

folder_id

string

ID of the folder that the registry belongs to.

name

string

Name of the registry.

status

enum Status

Output only. Status of the registry.

  • STATUS_UNSPECIFIED
  • CREATING: Registry is being created.
  • ACTIVE: Registry is ready to use.
  • DELETING: Registry is being deleted.

created_at

google.protobuf.Timestamp

Output only. Creation timestamp in RFC3339 text format.

labels

object (map<string, string>)

Resource labels as key:value pairs. Maximum of 64 per resource.
Previous
Get
Next
Create