[Документация Yandex Cloud](../../../../index.md) > [Yandex Managed Service for OpenSearch](../../../index.md) > Справочник API > [gRPC (англ.)](../index.md) > [Backup](index.md) > List

# Managed Service for OpenSearch API, gRPC: BackupService.List

Returns the list of available backups for the specified OpenSearch cluster.

## gRPC request

**rpc List ([ListBackupsRequest](#yandex.cloud.mdb.opensearch.v1.ListBackupsRequest)) returns ([ListBackupsResponse](#yandex.cloud.mdb.opensearch.v1.ListBackupsResponse))**

## ListBackupsRequest {#yandex.cloud.mdb.opensearch.v1.ListBackupsRequest}

```json
{
  "folder_id": "string",
  "page_size": "int64",
  "page_token": "string"
}
```

#|
||Field | Description ||
|| folder_id | **string**

Required field. ID of the folder to list backups in.

The maximum string length in characters is 50. ||
|| page_size | **int64**

The maximum number of results per page that should be returned.
If the number of available results is larger than `page_size`, the service returns
a [ListBackupsResponse.next_page_token](#yandex.cloud.mdb.opensearch.v1.ListBackupsResponse) that can be used to get the next page of results
in subsequent list requests.
Default value is 100.

Acceptable values are 0 to 1000, inclusive. ||
|| page_token | **string**

The page token. To get the next page of results, set `page_token` to the [ListBackupsResponse.next_page_token](#yandex.cloud.mdb.opensearch.v1.ListBackupsResponse)
returned by the previous list request.

The maximum string length in characters is 100. ||
|#

## ListBackupsResponse {#yandex.cloud.mdb.opensearch.v1.ListBackupsResponse}

```json
{
  "backups": [
    {
      "id": "string",
      "folder_id": "string",
      "source_cluster_id": "string",
      "started_at": "google.protobuf.Timestamp",
      "created_at": "google.protobuf.Timestamp",
      "indices": [
        "string"
      ],
      "opensearch_version": "string",
      "size_bytes": "int64",
      "indices_total": "int64",
      "incremental_size_bytes": "int64",
      "total_size_bytes": "int64",
      "free_space_required_bytes": "int64"
    }
  ],
  "next_page_token": "string"
}
```

#|
||Field | Description ||
|| backups[] | **[Backup](#yandex.cloud.mdb.opensearch.v1.Backup)**

Requested list of backups. ||
|| next_page_token | **string**

This token allows you to get the next page of results for a list request.
If the number of results is larger than [ListBackupsRequest.page_size](#yandex.cloud.mdb.opensearch.v1.ListBackupsRequest) specified in the request,
use the `next_page_token` as the value for the [ListBackupsRequest.page_token](#yandex.cloud.mdb.opensearch.v1.ListBackupsRequest) parameter in the next list request.
Each subsequent ListBackups request has its own `next_page_token` to continue paging through the results. ||
|#

## Backup {#yandex.cloud.mdb.opensearch.v1.Backup}

#|
||Field | Description ||
|| id | **string**

Required. ID of the backup. ||
|| folder_id | **string**

ID of the folder that the backup belongs to. ||
|| source_cluster_id | **string**

ID of the OpenSearch cluster that the backup was created for. ||
|| started_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)**

Time when the backup operation was started. ||
|| created_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)**

Time when the backup operation was completed. ||
|| indices[] | **string**

Names of indices in the backup.

The maximum number of elements is 100. ||
|| opensearch_version | **string**

OpenSearch version used to create the backup. ||
|| size_bytes | **int64**

Size of the backup in bytes. ||
|| indices_total | **int64**

The number of indices in the backup. ||
|| incremental_size_bytes | **int64**

Size of files which were copied as part of the incremental snapshot. ||
|| total_size_bytes | **int64**

Size of files that are referenced by the snapshot. ||
|| free_space_required_bytes | **int64**

The space amount required to restore from this backup. ||
|#