Contact UsGet started

Information about existing MongoDB clusters

Written by
Updated at November 18, 2024

You can request detailed information about each Managed Service for MongoDB cluster you created.

Getting a list of database clusters in a folder

Go to the folder page and select Managed Service for MongoDB.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To request a list of MongoDB clusters in the default folder, run the command:

yc managed-mongodb cluster list

Result:

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

To get a list of DB clusters in a folder, use the list REST API method for the Cluster resource or the ClusterService/List gRPC API call and provide the folder ID in the folderId request parameter.

Getting detailed information about a cluster

  1. Go to the folder page and select Managed Service for MongoDB.
  2. Click the cluster name.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To get information about the MongoDB cluster, run the following command:

yc managed-mongodb cluster get <cluster_name_or_ID>

You can request the cluster ID and name with a list of clusters in the folder.

To get cluster details, use the get REST API method for the Cluster resource or the ClusterService/Get gRPC API call and provide the cluster ID in the request.

Viewing operations with clusters

All actions with Managed Service for MongoDB clusters are logged as a list of operations. Each operation is assigned a unique ID.

Getting a list of operations

To view operations with all Managed Service for MongoDB clusters, in the left-hand panel, select Operations. In the list that opens, you will also see operations with the resources that were deleted.

You can get a list of operations for a cluster:

  1. In the management console, open the folder with the cluster.

  2. Select Managed Service for MongoDB.

  3. In the left-hand panel, select Clusters.

  4. Select the cluster you need.

  5. Go to the Operations panel for the selected cluster.

    You will see a list of operations with the selected cluster.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To get a list of operations for a Managed Service for MongoDB cluster, 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 MongoDB cluster |
+----------------------+---------------------+----------------------+---------------------+--------+------------------------+

You can get the cluster ID and name with a list of clusters in the folder.

By default, information about operations is provided as text. To get detailed information, specify the yaml or json output data format using the --format flag:

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

Result:

- id: c9ql1rfrqk4u********
  description: Create MongoDB 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

Use the listOperations REST API method for the Cluster resource or the ClusterService/ListOperations gRPC API call and provide the cluster ID in the request.

You can get the cluster ID with a list of clusters in the folder.

Getting detailed information about an operation

  1. Get a list of operations for the cluster.

  2. Copy the ID of the operation.

  3. Get detailed information about the operation:

    If you do not have the Yandex Cloud command line interface yet, install and initialize it.

    The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

    Run this command:

    yc operation get <operation_ID>

    Result:

    id: c9ql1rfrqk4u********
description: Create MongoDB 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/yandex.cloud.mdb.mongodb.v1.Cluster
...

    Use the get REST API method for the Operation resource or the OperationService/Get gRPC API call and provide the operation ID in the request.

See also

Previous
All guides
Next
Creating a cluster