Информация об имеющихся кластерах OpenSearch

Статья создана

Yandex Cloud

Улучшена

mmerihsesh

Обновлена 29 декабря 2025 г.

Получить список кластеров в каталоге
Получить детальную информацию о кластере
Посмотреть операции с кластерами
- Получить список операций
- Получить подробную информацию об операции

Вы можете запросить детальную информацию о каждом созданном вами кластере Managed Service for OpenSearch.

Получить список кластеров в каталоге

Консоль управления

CLI

REST API

gRPC API

В консоли управления перейдите на страницу каталога.
Перейдите в сервис Managed Service for OpenSearch.

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

Чтобы запросить список кластеров OpenSearch в каталоге, заданном по умолчанию, выполните команду:

yc managed-opensearch cluster list

+----------------------+------+-----------------------------+--------+---------+
|          ID          | NAME |         CREATED AT          | HEALTH | STATUS  |
+----------------------+------+-----------------------------+--------+---------+
| c9wlk4v14uq7******** | myos | 2023-12-19T10:04:14.645214Z | ALIVE  | RUNNING |
| ...                                                                          |
+----------------------+------+-----------------------------+--------+---------+

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Воспользуйтесь методом Cluster.List и выполните запрос, например, с помощью cURL:
```
curl \
    --request GET \
    --header "Authorization: Bearer $IAM_TOKEN" \
    --url 'https://mdb.api.cloud.yandex.net/managed-opensearch/v1/clusters' \
    --url-query folderId=<идентификатор_каталога>
```
Идентификатор каталога можно запросить со списком каталогов в облаке.
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ClusterService.List и выполните запрос, например, с помощью gRPCurl:

grpcurl \
    -format json \
    -import-path ~/cloudapi/ \
    -import-path ~/cloudapi/third_party/googleapis/ \
    -proto ~/cloudapi/yandex/cloud/mdb/opensearch/v1/cluster_service.proto \
    -rpc-header "Authorization: Bearer $IAM_TOKEN" \
    -d '{
          "folder_id": "<идентификатор_каталога>"
        }' \
    mdb.api.cloud.yandex.net:443 \
    yandex.cloud.mdb.opensearch.v1.ClusterService.List

Идентификатор каталога можно запросить со списком каталогов в облаке.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получить детальную информацию о кластере

Консоль управления

CLI

REST API

gRPC API

В консоли управления перейдите на страницу каталога.
Перейдите в сервис Managed Service for OpenSearch.
Нажмите на имя нужного кластера.

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

Чтобы получить информацию о кластере OpenSearch, выполните команду:

yc managed-opensearch cluster get <имя_или_идентификатор_кластера>

Имя и идентификатор кластера можно запросить со списком кластеров в каталоге.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Воспользуйтесь методом Cluster.Get и выполните запрос, например, с помощью cURL:
```
curl \
    --request GET \
    --header "Authorization: Bearer $IAM_TOKEN" \
    --url 'https://mdb.api.cloud.yandex.net/managed-opensearch/v1/clusters/<идентификатор_кластера>'
```
Идентификатор кластера можно запросить со списком кластеров в каталоге.
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ClusterService.Get и выполните запрос, например, с помощью gRPCurl:

grpcurl \
    -format json \
    -import-path ~/cloudapi/ \
    -import-path ~/cloudapi/third_party/googleapis/ \
    -proto ~/cloudapi/yandex/cloud/mdb/opensearch/v1/cluster_service.proto \
    -rpc-header "Authorization: Bearer $IAM_TOKEN" \
    -d '{
          "cluster_id": "<идентификатор_кластера>"
        }' \
    mdb.api.cloud.yandex.net:443 \
    yandex.cloud.mdb.opensearch.v1.ClusterService.Get

Идентификатор кластера можно запросить со списком кластеров в каталоге.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Посмотреть операции с кластерами

Все действия с кластерами Managed Service for OpenSearch сохраняются в виде списка операций. Каждой операции присваивается уникальный идентификатор.

Получить список операций

Консоль управления

CLI

REST API

gRPC API

Чтобы получить список операций для кластера:

В консоли управления откройте каталог, в котором находится кластер.
Перейдите в сервис Managed Service for OpenSearch.
На панели слева выберите Кластеры.
Выберите нужный кластер.
Перейдите на панель Операции для выбранного кластера.

В открывшемся списке отображаются операции с выбранным кластером.

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

Чтобы получить список операций для кластера Managed Service for OpenSearch, воспользуйтесь командой:

yc managed-opensearch cluster list-operations <имя_или_идентификатор_кластера>

Результат:

+----------------------+---------------------+----------------------+---------------------+--------+---------------------------+
|          ID          |     CREATED AT      |      CREATED BY      |     MODIFIED AT     | STATUS |        DESCRIPTION        |
+----------------------+---------------------+----------------------+---------------------+--------+---------------------------+
| dqh0ntf6batm******** | 2024-09-07 16:36:46 | aje9k8luj4qf******** | 2024-09-07 16:44:12 | DONE   | Create OpenSearch cluster |
+----------------------+---------------------+----------------------+---------------------+--------+---------------------------+

Идентификатор кластера можно запросить со списком кластеров в каталоге.

По умолчанию информация об операциях выводится в текстовом формате. Чтобы получить более подробную информацию, укажите формат yaml или json для выводимых данных с помощью параметра --format:

yc managed-opensearch cluster list-operations c9qk2926qqu9******** --format yaml

Результат:

- id: dqh0ntf6batm********
  description: Create OpenSearch cluster
  created_at: "2024-09-07T16:36:46.816682Z"
  created_by: aje9k8luj4qf********
  modified_at: "2024-09-07T16:44:12.944302Z"
  done: true
  metadata:
    '@type': type.googleapis.com/yandex.cloud.mdb.opensearch.v1.CreateClusterMetadata
    cluster_id: c9q13q0acgv7********
  response:
    '@type': type.googleapis.com/google.rpc.Status
    message: OK

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Воспользуйтесь методом Cluster.ListOperations и выполните запрос, например, с помощью cURL:
```
curl \
    --request GET \
    --header "Authorization: Bearer $IAM_TOKEN" \
    --url 'https://mdb.api.cloud.yandex.net/managed-opensearch/v1/clusters/<идентификатор_кластера>/operations'
```
Идентификатор кластера можно запросить со списком кластеров в каталоге.
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ClusterService.ListOperations и выполните запрос, например, с помощью gRPCurl:

grpcurl \
    -format json \
    -import-path ~/cloudapi/ \
    -import-path ~/cloudapi/third_party/googleapis/ \
    -proto ~/cloudapi/yandex/cloud/mdb/opensearch/v1/cluster_service.proto \
    -rpc-header "Authorization: Bearer $IAM_TOKEN" \
    -d '{
          "cluster_id": "<идентификатор_кластера>"
        }' \
    mdb.api.cloud.yandex.net:443 \
    yandex.cloud.mdb.opensearch.v1.ClusterService.ListOperations

Идентификатор кластера можно запросить со списком кластеров в каталоге.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получить подробную информацию об операции

Консоль управления

CLI

REST API

gRPC API

Перейдите в список операций для нужного кластера.
Нажмите на идентификатор операции, которую вы хотите посмотреть.

Примечание

Операции, для которых доступна детальная информация, отмечены значком рядом с идентификатором.

В детальной информации приводится иерархический список шагов операции. На первом уровне — действия с кластером, на втором — действия с хостами. Список может различаться для разных операций:

Если шаг выполняется или уже завершен, для него отображается дата и время начала выполнения.
Если выполнение шага еще не началось, для него отображается статус В очереди.

В списке отображаются следующие действия:

Preparing metadata — подготовка информации и данных для выполнения операции.
Preparing backup storage — подготовка хранилища для резервных копий.
Creating cluster — создание кластера.
Installing software — установка программного обеспечения (например, создается база данных, устанавливаются вспомогательные пакеты-плагины).
Initializing database — инициализация базы данных.
Infrastructure integration — создание связей новых объектов с инфраструктурой Yandex Cloud (например, распространяется DNS, выпускаются сертификаты, хосты включаются в систему мониторинга).
Updating host groups — обновление группы хостов.
Updating hosts — обновление хостов.
Completing — завершение операции.

Действия с хостами:

Reserving resources — резервирование ресурсов для хоста.
Creating host — создание хоста.
Launching host — запуск хоста.
Preparing host — подготовка хоста к работе.
Updating database software — обновление программного обеспечения.
Updating database services — обновление сервисов базы данных.
Creating DNS records — создание DNS-записи.
Restarting database — перезапуск базы данных.

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

Чтобы получить подробную информацию об операции, выполните команду:

yc operation get <идентификатор_операции>

Идентификатор операции можно получить со списком операций для кластера.

Пример выдачи для завершенной операции по созданию кластера:

id: mos05eskhu9c********
description: Create OpenSearch cluster
created_at: "2025-12-29T02:29:51.793062Z"
created_by: ajefhe0o8uas********
modified_at: "2025-12-29T02:43:23.309182Z"
done: true
metadata:
  '@type': type.googleapis.com/yandex.cloud.mdb.opensearch.v1.CreateClusterMetadata
  cluster_id: c9q4g9irv5mc********
  operation_log:
    entities:
      - cluster_id: c9q4g9irv5mc********
        action: Preparing metadata
        started_at: "2025-12-29T02:29:53.865371Z"
      - cluster_id: c9q4g9irv5mc********
        action: Preparing backup storage
        started_at: "2025-12-29T02:29:56.453900Z"
      - cluster_id: c9q4g9irv5mc********
        action: Creating cluster
        started_at: "2025-12-29T02:30:15.668070Z"
        hosts:
          - fqdn: rc1a-r74k9d6q********.mdb.yandexcloud.net
            action: Reserving resources
            started_at: "2025-12-29T02:30:18.033652Z"
          - fqdn: rc1b-dpb2qtc7********.mdb.yandexcloud.net
            action: Reserving resources
            started_at: "2025-12-29T02:30:21.229073Z"
          - fqdn: rc1d-h86ujdc3********.mdb.yandexcloud.net
            action: Reserving resources
            started_at: "2025-12-29T02:30:25.193509Z"
          - fqdn: rc1a-fohc5nvj********.mdb.yandexcloud.net
            action: Reserving resources
            started_at: "2025-12-29T02:30:32.402818Z"
          - fqdn: rc1a-r74k9d6q********.mdb.yandexcloud.net
            action: Creating host
            started_at: "2025-12-29T02:30:38.915704Z"
          - fqdn: rc1b-dpb2qtc7********.mdb.yandexcloud.net
            action: Creating host
            started_at: "2025-12-29T02:30:40.253821Z"
          - fqdn: rc1d-h86ujdc3********.mdb.yandexcloud.net
            action: Creating host
            started_at: "2025-12-29T02:30:41.492932Z"
          - fqdn: rc1a-fohc5nvj********.mdb.yandexcloud.net
            action: Creating host
            started_at: "2025-12-29T02:30:42.740551Z"
      - cluster_id: c9q4g9irv5mc********
        action: Installing software
        started_at: "2025-12-29T02:33:15.769930Z"
        hosts:
          - fqdn: rc1d-h86ujdc3********.mdb.yandexcloud.net
            action: Launching host
            started_at: "2025-12-29T02:33:15.962886Z"
          - fqdn: rc1a-fohc5nvj********.mdb.yandexcloud.net
            action: Launching host
            started_at: "2025-12-29T02:33:16.190931Z"
          - fqdn: rc1a-r74k9d6q********.mdb.yandexcloud.net
            action: Launching host
            started_at: "2025-12-29T02:33:16.397641Z"
          - fqdn: rc1b-dpb2qtc7********.mdb.yandexcloud.net
            action: Launching host
            started_at: "2025-12-29T02:33:26.602596Z"
          - fqdn: rc1a-r74k9d6q********.mdb.yandexcloud.net
            action: Updating database software
            started_at: "2025-12-29T02:33:26.955555Z"
          - fqdn: rc1b-dpb2qtc7********.mdb.yandexcloud.net
            action: Updating database software
            started_at: "2025-12-29T02:33:27.164688Z"
          - fqdn: rc1d-h86ujdc3********.mdb.yandexcloud.net
            action: Updating database software
            started_at: "2025-12-29T02:33:27.372229Z"
          - fqdn: rc1a-fohc5nvj********.mdb.yandexcloud.net
            action: Updating database software
            started_at: "2025-12-29T02:33:27.584061Z"
      - cluster_id: c9q4g9irv5mc********
        action: Initializing database
        started_at: "2025-12-29T02:35:52.445284Z"
      - cluster_id: c9q4g9irv5mc********
        action: Infrastructure integration
        started_at: "2025-12-29T02:41:14.794423Z"
        hosts:
          - fqdn: rc1a-r74k9d6q********.mdb.yandexcloud.net
            action: Creating DNS records
            started_at: "2025-12-29T02:41:15.073269Z"
          - fqdn: rc1b-dpb2qtc7********.mdb.yandexcloud.net
            action: Creating DNS records
            started_at: "2025-12-29T02:41:15.328852Z"
          - fqdn: rc1d-h86ujdc3********.mdb.yandexcloud.net
            action: Creating DNS records
            started_at: "2025-12-29T02:41:15.578930Z"
          - fqdn: rc1a-fohc5nvj********.mdb.yandexcloud.net
            action: Creating DNS records
            started_at: "2025-12-29T02:41:15.837808Z"
          - fqdn: rc1a-r74k9d6q********.mdb.yandexcloud.net
            action: Updating database software
            started_at: "2025-12-29T02:41:24.297788Z"
          - fqdn: rc1b-dpb2qtc7********.mdb.yandexcloud.net
            action: Updating database software
            started_at: "2025-12-29T02:41:24.514965Z"
          - fqdn: rc1d-h86ujdc3********.mdb.yandexcloud.net
            action: Updating database software
            started_at: "2025-12-29T02:41:24.724648Z"
response:
  '@type': type.googleapis.com/yandex.cloud.mdb.opensearch.v1.Cluster
  id: c9q4g9irv5mc********
  ...

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Воспользуйтесь методом Operation.Get и выполните запрос, например с помощью cURL:
```
curl \
    --request GET \
    --header "Authorization: Bearer $IAM_TOKEN" \
    --url 'https://operation.api.cloud.yandex.net/operations/<идентификатор_операции>'
```
Идентификатор операции можно получить со списком операций для кластера.
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом OperationService.Get и выполните запрос, например с помощью gRPCurl:

grpcurl \
    -format json \
    -import-path ~/cloudapi/ \
    -import-path ~/cloudapi/third_party/googleapis/ \
    -proto ~/cloudapi/yandex/cloud/operation/operation_service.proto \
    -rpc-header "Authorization: Bearer $IAM_TOKEN" \
    -d '{
          "operation_id": "<идентификатор_операции>"
        }' \
    operation.api.cloud.yandex.net:443 \
    yandex.cloud.operation.OperationService.Get

Идентификатор операции можно получить со списком операций для кластера.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

См. также

Работа с операциями

Информация об имеющихся кластерах OpenSearch

Получить список кластеров в каталогеПолучить список кластеров в каталоге

Получить детальную информацию о кластереПолучить детальную информацию о кластере

Посмотреть операции с кластерамиПосмотреть операции с кластерами

Получить список операцийПолучить список операций

Получить подробную информацию об операцииПолучить подробную информацию об операции

См. такжеСм. также

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

Получить список кластеров в каталоге

Получить детальную информацию о кластере

Посмотреть операции с кластерами

Получить список операций

Получить подробную информацию об операции

См. также