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

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

Yandex Cloud

Улучшена

mmerihsesh

Обновлена 27 марта 2026 г.

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

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

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

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

CLI

REST API

gRPC API

Перейдите на страницу каталога.
Перейдите в сервис Yandex StoreDoc.

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

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

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

yc managed-mongodb cluster list

Результат:

+----------------------+------------+-----------------------------+--------+---------+
|          ID          |    NAME    |         CREATED AT          | HEALTH | STATUS  |
+----------------------+------------+-----------------------------+--------+---------+
| c9wlk4v14uq7******** | mymg       | 2018-11-02T10: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-mongodb/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/mongodb/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "folder_id": "<идентификатор_каталога>"
      }' \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.mongodb.v1.ClusterService.List

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

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

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

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

CLI

REST API

gRPC API

Перейдите на страницу каталога.
Перейдите в сервис Yandex StoreDoc.
Нажмите на имя нужного кластера.

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

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

yc managed-mongodb 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-mongodb/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/mongodb/v1/cluster_service.proto \
    -rpc-header "Authorization: Bearer $IAM_TOKEN" \
    -d '{
          "cluster_id": "<идентификатор_кластера>"
        }' \
    mdb.api.cloud.yandex.net:443 \
    yandex.cloud.mdb.mongodb.v1.ClusterService.Get

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

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

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

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

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

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

CLI

REST API

gRPC API

Чтобы посмотреть операции со всеми кластерами Yandex StoreDoc, на панели слева выберите Операции. В открывшемся списке также отображаются операции для ресурсов, которые были удалены.

Можно получить список операций для кластера:

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

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

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

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

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

Результат:

+----------------------+---------------------+----------------------+---------------------+--------+-------------------------+
|          ID          |     CREATED AT      |      CREATED BY      |     MODIFIED AT     | STATUS |       DESCRIPTION       |
+----------------------+---------------------+----------------------+---------------------+--------+-------------------------+
| c9ql1rfrqk4u******** | 2024-09-07 16:37:10 | aje9k8luj4qf******** | 2024-09-07 16:44:28 | DONE   | Create StoreDoc cluster |
+----------------------+---------------------+----------------------+---------------------+--------+-------------------------+

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

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

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

Результат:

- id: c9ql1rfrqk4u********
  description: Create StoreDoc cluster
  created_at: "2024-09-07T16:37:10.533508Z"
  created_by: aje9k8luj4qf********
  modified_at: "2024-09-07T16:44:28.147771Z"
  done: true
  metadata:
    '@type': type.googleapis.com/yandex.cloud.mdb.mongodb.v1.CreateClusterMetadata
    cluster_id: c9q8tmbam8co********
  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-mongodb/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/mongodb/v1/cluster_service.proto \
    -rpc-header "Authorization: Bearer $IAM_TOKEN" \
    -d '{
          "cluster_id": "<идентификатор_кластера>"
        }' \
    mdb.api.cloud.yandex.net:443 \
    yandex.cloud.mdb.mongodb.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: mg4rld37o0rq********
description: Create StoreDoc cluster
created_at: "2026-01-29T00:57:43.452529Z"
created_by: ajegrmkclceh********
modified_at: "2026-01-29T01:03:45.266238Z"
done: true
metadata:
  '@type': type.googleapis.com/yandex.cloud.mdb.mongodb.v1.CreateClusterMetadata
  cluster_id: c9qiom6ca92e********
  operation_log:
    entities:
      - cluster_id: c9qiom6ca92e********
        action: Preparing metadata
        started_at: "2026-01-29T00:57:45.309067Z"
      - cluster_id: c9qiom6ca92e********
        action: Preparing backup storage
        started_at: "2026-01-29T00:57:47.369642Z"
      - cluster_id: c9qiom6ca92e********
        action: Creating cluster
        started_at: "2026-01-29T00:58:00.630246Z"
        hosts:
          - fqdn: rc1b-adf7j2fj********.mdb.yandexcloud.net
            action: Reserving resources
            started_at: "2026-01-29T00:58:05.346173Z"
          - fqdn: rc1b-adf7j2fj********.mdb.yandexcloud.net
            action: Creating host
            started_at: "2026-01-29T00:58:11.919280Z"
      - cluster_id: c9qiom6ca92e********
        action: Installing software
        started_at: "2026-01-29T00:58:56.969708Z"
        hosts:
          - fqdn: rc1b-adf7j2fj********.mdb.yandexcloud.net
            action: Launching host
            started_at: "2026-01-29T00:59:22.489609Z"
          - fqdn: rc1b-adf7j2fj********.mdb.yandexcloud.net
            action: Updating database software
            started_at: "2026-01-29T00:59:22.866599Z"
      - cluster_id: c9qiom6ca92e********
        action: Initializing database
        started_at: "2026-01-29T00:59:39.858475Z"
      - cluster_id: c9qiom6ca92e********
        action: Infrastructure integration
        started_at: "2026-01-29T01:03:33.564786Z"
        hosts:
          - fqdn: rc1b-adf7j2fj********.mdb.yandexcloud.net
            action: Creating DNS records
            started_at: "2026-01-29T01:03:33.806317Z"
response:
  '@type': type.googleapis.com/yandex.cloud.mdb.mongodb.v1.Cluster
  id: c9qiom6ca92e********
  ...

Получите 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

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

См. также

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

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

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

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

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

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

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

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

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

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

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

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

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

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

См. также