Get started
Yandex Serverless Containers

Serverless Containers Service, REST: Container.list

Written by

Retrieves the list of containers in the specified folder.

HTTP request

GET https://serverless-containers.api.cloud.yandex.net/containers/v1/containers

Query parameters

Parameter Description
folderId

Required. ID of the folder to list containers in.

To get a folder ID make a list request.
pageSize

The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

Default value: 100.
pageToken

Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request.
filter

A filter expression that filters containers listed in the response.

The expression must specify:

  1. The field name. Currently filtering can only be applied to the Container.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]. Example of a filter: name="my-container".

Response

HTTP Code: 200 - OK

{
  "containers": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "url": "string",
      "status": "string"
    }
  ],
  "nextPageToken": "string"
}
Field Description
containers[] object

List of containers in the specified folder.
containers[].
id		 string

ID of the container. Generated at creation time.
containers[].
folderId		 string

ID of the folder that the container belongs to.
containers[].
createdAt		 string (date-time)

Creation timestamp for the container.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
containers[].
name		 string

Name of the container. The name is unique within the folder.
containers[].
description		 string

Description of the container.
containers[].
labels		 object

Container labels as key:value pairs.
containers[].
url		 string

URL that needs to be requested to call the container.
containers[].
status		 string

Status of the container.

  • CREATING: Container is being created.
  • ACTIVE: Container is ready for use.
  • DELETING: Container is being deleted.
  • ERROR: Container failed. The only allowed action is delete.
nextPageToken string

Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use nextPageToken as the value for the pageToken parameter in the next list request.

Each subsequent page will have its own nextPageToken to continue paging through the results.
In this article: