Yandex Cloud
Поиск
Связаться с намиПодключиться
  • Истории успеха
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Контейнеры
    • Инструменты разработчика
    • Бессерверные вычисления
    • Безопасность
    • Мониторинг и управление ресурсами
    • AI Studio
    • Бизнес-инструменты
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Тарифы Yandex Cloud
    • Промоакции и free tier
    • Правила тарификации
  • Истории успеха
  • Документация
  • Блог
Проект Яндекса
© 2025 ООО «Яндекс.Облако»
Yandex Managed Service for OpenSearch
  • Начало работы
  • Управление доступом
  • Правила тарификации
  • Справочник Terraform
    • Аутентификация в API
      • Overview
        • Overview
        • Get
        • List
  • Метрики Monitoring
  • Аудитные логи Audit Trails
  • Публичные материалы
  • История изменений
  • Вопросы и ответы

В этой статье:

  • gRPC request
  • ListBackupsRequest
  • ListBackupsResponse
  • Backup
  1. Справочник API
  2. gRPC (англ.)
  3. Backup
  4. List

Managed Service for OpenSearch API, gRPC: BackupService.List

Статья создана
Yandex Cloud
Обновлена 4 августа 2025 г.
  • gRPC request
  • ListBackupsRequest
  • ListBackupsResponse
  • Backup

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

gRPC requestgRPC request

rpc List (ListBackupsRequest) returns (ListBackupsResponse)

ListBackupsRequestListBackupsRequest

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

Field

Description

folder_id

string

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

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 that can be used to get the next page of results
in subsequent list requests.

Default value is 100.

page_token

string

The page token. To get the next page of results, set page_token to the ListBackupsResponse.next_page_token
returned by the previous list request.

ListBackupsResponseListBackupsResponse

{
  "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

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 specified in the request,
use the next_page_token as the value for the ListBackupsRequest.page_token parameter in the next list request.

Each subsequent ListBackups request has its own next_page_token to continue paging through the results.

BackupBackup

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

Time when the backup operation was started.

created_at

google.protobuf.Timestamp

Time when the backup operation was completed.

indices[]

string

Names of indices in the backup.

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.

Была ли статья полезна?

Предыдущая
Get
Следующая
Overview
Проект Яндекса
© 2025 ООО «Яндекс.Облако»