Information about existing Yandex StoreDoc clusters

Written by

Yandex Cloud

Updated at May 5, 2026

Getting a list of database clusters in your folder
Getting cluster details
Viewing cluster operations
- Getting a list of operations
- Getting operation details

You can request detailed information for each Yandex StoreDoc cluster you have created.

Getting a list of database clusters in your folder

Management console

CLI

REST API

gRPC API

Open the folder dashboard.
Navigate to the Yandex StoreDoc service.

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

To get a list of Yandex StoreDoc clusters in the default folder, run this command:

yc managed-mongodb cluster list

Result:

+----------------------+------------+-----------------------------+--------+---------+
|          ID          |    NAME    |         CREATED AT          | HEALTH | STATUS  |
+----------------------+------------+-----------------------------+--------+---------+
| c9wlk4v14uq7******** | mymg       | 2018-11-02T10:04:14.645214Z | ALIVE  | RUNNING |
| ...                                                                                |
+----------------------+------------+-----------------------------+--------+---------+

Get an IAM token for API authentication and place it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```

Call the Cluster.List method, e.g., via the following cURL request:

curl \
    --request GET \
    --header "Authorization: Bearer $IAM_TOKEN" \
    --url 'https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters' \
    --url-query folderId=<folder_ID>

You can get the folder ID from the list of your cloud folders.

Check the server response to make sure your request was successful.

Get an IAM token for API authentication and place it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Clone the cloudapi repository:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

Call the ClusterService.List method, e.g., via the following gRPCurl request:

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": "<folder_ID>"
      }' \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.mongodb.v1.ClusterService.List

You can get the folder ID from the list of your cloud folders.

Check the server response to make sure your request was successful.

Getting cluster details

Management console

CLI

REST API

gRPC API

Open the folder dashboard.
Navigate to the Yandex StoreDoc service.
Click the name of your cluster.

If you do not have the Yandex Cloud CLI yet, install and initialize it.

To get Yandex StoreDoc cluster details, run the following command:

yc managed-mongodb cluster get <cluster_name_or_ID>

You can get the cluster’s name and ID from the list of clusters in your folder.

Get an IAM token for API authentication and place it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```

Call the Cluster.Get method, e.g., via the following cURL request:

curl \
    --request GET \
    --header "Authorization: Bearer $IAM_TOKEN" \
    --url 'https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/<cluster_ID>'

You can get the cluster ID from the list of clusters in your folder.

Check the server response to make sure your request was successful.

Get an IAM token for API authentication and place it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Clone the cloudapi repository:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

Call the ClusterService.Get method, e.g., via the following gRPCurl request:

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": "<cluster_ID>"
        }' \
    mdb.api.cloud.yandex.net:443 \
    yandex.cloud.mdb.mongodb.v1.ClusterService.Get

You can get the cluster ID from the list of clusters in your folder.

Check the server response to make sure your request was successful.

Viewing cluster operations

All actions performed on Yandex StoreDoc clusters are logged, with each operation assigned a unique ID.

Getting a list of operations

Management console

CLI

REST API

gRPC API

To view operations for all Yandex StoreDoc clusters, select Operations in the left-hand panel. The list that opens displays operations for both active and deleted resources.

You can get a list of cluster operations as follows:

In the management console, open the folder containing your cluster.
Navigate to the Yandex StoreDoc service.
In the left-hand panel, select Clusters.
Select the cluster and open the Operations tab.

You will see the list of cluster operations.

If you do not have the Yandex Cloud CLI yet, install and initialize it.

To get a list of Yandex StoreDoc cluster operations, run this command:

yc managed-mongodb cluster list-operations <cluster_name_or_ID>

Result:

+----------------------+---------------------+----------------------+---------------------+--------+-------------------------+
|          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 |
+----------------------+---------------------+----------------------+---------------------+--------+-------------------------+

You can get the cluster’s name and ID from list of clusters in your folder.

By default, operation details are displayed in text format. To get more detailed information, specify the yaml or json output format using the --format argument:

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

Result:

- 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

Get an IAM token for API authentication and place it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```

Call the Cluster.ListOperations method, e.g., via the following cURL request:

curl \
    --request GET \
    --header "Authorization: Bearer $IAM_TOKEN" \
    --url 'https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/<cluster_ID>/operations'

You can get the cluster ID from the list of clusters in your folder.

Check the server response to make sure your request was successful.

Get an IAM token for API authentication and place it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Clone the cloudapi repository:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

Call the ClusterService.ListOperations method, e.g., via the following gRPCurl request:

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": "<cluster_ID>"
        }' \
    mdb.api.cloud.yandex.net:443 \
    yandex.cloud.mdb.mongodb.v1.ClusterService.ListOperations

You can get the cluster ID from the list of clusters in your folder.

Check the server response to make sure your request was successful.

Getting operation details

Management console

CLI

REST API

gRPC API

Navigate to the list of all cluster operations or operations for your specific cluster.
Click the ID of the operation you need.

Note

Operations where details are available have the icon next to their ID.

Operation details include a hierarchical list of the operation steps. The first-level items are actions with the cluster, and the second-level ones are actions with hosts. The list may vary for different operations:

If a step is running or has completed, its start date and time are displayed.
If a step has not yet started, it has the In queue status.

The list displays the following actions:

Preparing metadata: Preparing information and data for the operation.
Preparing backup storage: Preparing storage for backups.
Creating cluster: Creating a cluster.
Installing software: Installing software (e.g., creating a database or installing auxiliary plugin packages).
Initializing database: Initializing a database.
Infrastructure integration: Creating connections between new objects and the Yandex Cloud infrastructure (e.g., DNS propagation, issuing certificates, adding hosts to the monitoring system).
Updating host groups: Updating a host group.
Updating hosts: Updating hosts.
Completing: Completing the operation.

Actions with hosts:

Reserving resources: Allocating resources for a host.
Creating host: Creating a host.
Launching host: Starting a host.
Preparing host: Preparing a host.
Updating database software: Updating software.
Updating database services: Updating database services.
Creating DNS records: Creating a DNS record.
Restarting database: Restarting a database.

If you do not have the Yandex Cloud CLI yet, install and initialize it.

Run this command:

yc operation get <operation_ID>

You can get the operation ID with the list of operations for the cluster.

Here is an example of an output for the completed cluster creation operation:

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********
  ...

Get an IAM token for API authentication and place it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```

Call the Operation.Get method, e.g., via the following cURL request:

curl \
    --request GET \
    --header "Authorization: Bearer $IAM_TOKEN" \
    --url 'https://operation.api.cloud.yandex.net/operations/<operation_ID>'

Check the server response to make sure your request was successful.

Get an IAM token for API authentication and place it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Clone the cloudapi repository:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

Call the OperationService.Get method, e.g., via the following gRPCurl request:

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_ID>"
        }' \
    operation.api.cloud.yandex.net:443 \
    yandex.cloud.operation.OperationService.Get

Check the server response to make sure your request was successful.

Information about existing Yandex StoreDoc clusters

Getting a list of database clusters in your folder

Getting cluster details

Viewing cluster operations

Getting a list of operations

Getting operation details

See also

Was the article helpful?

Information about existing Yandex StoreDoc clusters

Getting a list of database clusters in your folderGetting a list of database clusters in your folder

Getting cluster detailsGetting cluster details

Viewing cluster operationsViewing cluster operations

Getting a list of operationsGetting a list of operations

Getting operation detailsGetting operation details

See alsoSee also

Was the article helpful?

Getting a list of database clusters in your folder

Getting cluster details

Viewing cluster operations

Getting a list of operations

Getting operation details

See also