Information about existing OpenSearch clusters
You can get detailed information about each Managed Service for OpenSearch cluster you created.
Getting a list of clusters in a folder
- In the management console
, navigate to the folder page. - Navigate to the Managed Service for OpenSearch service.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.
To get 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 |
| ... |
+----------------------+------+-----------------------------+--------+---------+
-
Get an IAM token for API authentication and put 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-opensearch/v1/clusters' \ --url-query folderId=<folder_ID>You can get the folder ID with the list of folders in the cloud.
-
View the server response to make sure your request was successful.
-
Get an IAM token for API authentication and put it in an environment variable:
export IAM_TOKEN="<IAM_token>" -
Clone the cloudapi
repository:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapiBelow, 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/opensearch/v1/cluster_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "folder_id": "<folder_ID>" }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.opensearch.v1.ClusterService.ListYou can get the folder ID with the list of folders in the cloud.
-
View the server response to make sure your request was successful.
Getting detailed information about a cluster
- In the management console
, navigate to the folder page. - Navigate to the Managed Service for OpenSearch service.
- Click the cluster name.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.
To get information about an OpenSearch cluster, run this command:
yc managed-opensearch cluster get <cluster_name_or_ID>
You can get the cluster name and ID with the list of clusters in the folder.
-
Get an IAM token for API authentication and put 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-opensearch/v1/clusters/<cluster_ID>'You can get the cluster ID with the list of clusters in the folder.
-
View the server response to make sure your request was successful.
-
Get an IAM token for API authentication and put it in an environment variable:
export IAM_TOKEN="<IAM_token>" -
Clone the cloudapi
repository:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapiBelow, 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/opensearch/v1/cluster_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "cluster_id": "<cluster_ID>" }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.opensearch.v1.ClusterService.GetYou can get the cluster ID with the list of clusters in the folder.
-
View the server response to make sure your request was successful.
Viewing operations with clusters
All actions with Managed Service for OpenSearch clusters are logged as a list of operations. Each operation gets its own unique ID.
Getting a list of operations
To get a list of operations for a cluster:
-
In the management console
, open the folder containing your cluster. -
Navigate to the Managed Service for OpenSearch service.
-
In the left-hand panel, select
Clusters. -
Select the cluster you need.
-
Navigate to the
Operations panel for the cluster you selected.You will see the list of operations with this cluster.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command 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 the list of clusters in the folder.
By default, information about operations is output as text. To get more detailed information, specify the yaml or json output data format using --format:
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
-
Get an IAM token for API authentication and put 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-opensearch/v1/clusters/<cluster_ID>/operations'You can get the cluster ID with the list of clusters in the folder.
-
View the server response to make sure your request was successful.
-
Get an IAM token for API authentication and put it in an environment variable:
export IAM_TOKEN="<IAM_token>" -
Clone the cloudapi
repository:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapiBelow, 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/opensearch/v1/cluster_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "cluster_id": "<cluster_ID>" }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.opensearch.v1.ClusterService.ListOperationsYou can get the cluster ID with the list of clusters in the folder.
-
View the server response to make sure your request was successful.
Getting operation details
- Navigate to the list of operations for your cluster.
- Click the ID of the operation you need.
Note
Operations where details are available have the
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 installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.
To get detailed information about an operation, 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: 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********
...
-
Get an IAM token for API authentication and put 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>'You can get the operation ID with the list of operations for the cluster.
-
Check the server response to make sure your request was successful.
-
Get an IAM token for API authentication and put it in an environment variable:
export IAM_TOKEN="<IAM_token>" -
Clone the cloudapi
repository:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapiBelow, 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.GetYou can get the operation ID with the list of operations for the cluster.
-
View the server response to make sure your request was successful.