Contact UsGet started

Information about existing OpenSearch clusters

Written by
Updated at November 18, 2024

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

Getting a list of clusters in a folder

In the management console, go to the folder page and select Managed Service for OpenSearch.

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 OpenSearch clusters in the default folder, run this command:

yc managed-opensearch cluster list

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

To get a list of 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.

The response will contain cluster names and IDs.

Getting detailed information about a cluster

  1. In the management console, go to the folder page and select Managed Service for OpenSearch.
  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 OpenSearch cluster, run the following command:

yc managed-opensearch cluster get <cluster_name_or_ID>

You can request the cluster name and ID 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 clusterId request parameter.

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

Viewing operations with clusters

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

Getting a list of operations

To get a list of operations for a cluster:

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

  2. Select Managed Service for OpenSearch.

  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 OpenSearch cluster, run this command:

yc managed-opensearch cluster list-operations <cluster_name_or_ID>

Result:

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

You can get the cluster ID 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-opensearch cluster list-operations c9qk2926qqu9******** --format yaml

Result:

- 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

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

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: 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/yandex.cloud.mdb.opensearch.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