Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Managed Service for Redis API, gRPC: BackupService.List

Written by
Updated at October 17, 2024

Retrieves the list of Redis backups available for the specified folder.

gRPC request

rpc List (ListBackupsRequest) returns (ListBackupsResponse)

ListBackupsRequest

{
  "folderId": "string",
  "pageSize": "int64",
  "pageToken": "string"
}

Field

Description

folderId

string

Required field. ID of the folder to list backups 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 pageSize, the service returns a ListBackupsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

pageToken

string

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

ListBackupsResponse

{
  "backups": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "google.protobuf.Timestamp",
      "sourceClusterId": "string",
      "startedAt": "google.protobuf.Timestamp",
      "sourceShardNames": [
        "string"
      ]
    }
  ],
  "nextPageToken": "string"
}

Field

Description

backups[]

Backup

Requested list of backups.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListBackupsRequest.pageSize, use the nextPageToken as the value
for the ListBackupsRequest.pageToken parameter in the next list request. Each subsequent
list request will have its own nextPageToken to continue paging through the results.

Backup

Description of a Redis backup. For more information, see
the Managed Service for Redis documentation.

Field

Description

id

string

ID of the backup.

folderId

string

ID of the folder that the backup belongs to.

createdAt

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format
(i.e. when the backup operation was completed).

sourceClusterId

string

ID of the Redis cluster that the backup was created for.

startedAt

google.protobuf.Timestamp

Start timestamp in RFC3339 text format
(i.e. when the backup operation was started).

sourceShardNames[]

string

Shard names used as a source for backup.
Previous
Get
Next
Delete