Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex Managed Service for ClickHouse®
  • Getting started
    • All guides
      • Information about existing clusters
      • Creating a cluster
      • Updating cluster settings
      • ClickHouse® version upgrade
      • Stopping and starting a cluster
      • Managing backups
      • Deleting a cluster
  • Access management
  • Terraform reference
  • Yandex Monitoring metrics
  • Audit Trails events
  • Public materials
  • Release notes

In this article:

  • Getting a list of database clusters in a folder
  • Getting detailed information about a cluster
  • Viewing operations with clusters
  • Getting a list of operations
  • Getting detailed information about an operation
  • See also
  1. Step-by-step guides
  2. Clusters
  3. Information about existing clusters

Information about existing ClickHouse® clusters

Written by
Yandex Cloud
Updated at May 5, 2025
  • Getting a list of database clusters in a folder
  • Getting detailed information about a cluster
  • Viewing operations with clusters
    • Getting a list of operations
    • Getting detailed information about an operation
    • See also

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

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

Management console
CLI
REST API
gRPC API

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

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

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

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

yc managed-clickhouse cluster list

+----------------------+------+-------------+---------+---------------------+--------+---------+
|          ID          | NAME | ENVIRONMENT | VERSION |     CREATED AT      | HEALTH | STATUS  |
+----------------------+------+-------------+---------+---------------------+--------+---------+
| c9qf1kmm0ebi******** | mych | PRODUCTION  |    23.8 | 2024-06-06 10:23:22 | ALIVE  | RUNNING |
| ...                                                                                          |
+----------------------+------+-------------+---------+---------------------+--------+---------+
  1. Get an IAM token for API authentication and put it into the environment variable:

    export IAM_TOKEN="<IAM_token>"
    
  2. Use the Cluster.list method and send the following request, e.g., via cURL:

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

    You can request the folder ID with the list of folders in the cloud.

  3. View the server response to make sure the request was successful.

  1. Get an IAM token for API authentication and put it into the environment variable:

    export IAM_TOKEN="<IAM_token>"
    
  2. Clone the cloudapi repository:

    cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
    

    Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

  3. Use the ClusterService.List call and send the following request, e.g., via gRPCurl:

    grpcurl \
        -format json \
        -import-path ~/cloudapi/ \
        -import-path ~/cloudapi/third_party/googleapis/ \
        -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
        -rpc-header "Authorization: Bearer $IAM_TOKEN" \
        -d '{
              "folder_id": "<folder_ID>"
            }' \
        mdb.api.cloud.yandex.net:443 \
        yandex.cloud.mdb.clickhouse.v1.ClusterService.List
    

    You can request the folder ID with the list of folders in the cloud.

  4. View the server response to make sure the request was successful.

Getting detailed information about a clusterGetting detailed information about a cluster

Management console
CLI
REST API
gRPC API
  1. In the management console, go to the folder page and select Managed Service for ClickHouse.
  2. Click the cluster name.

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

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

To get information about the ClickHouse® cluster, run the following command:

yc managed-clickhouse cluster get <cluster_name_or_ID>

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

  1. Get an IAM token for API authentication and put it into the environment variable:

    export IAM_TOKEN="<IAM_token>"
    
  2. Use the Cluster.Get method and send the following request, e.g., via cURL:

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

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

  3. View the server response to make sure the request was successful.

  1. Get an IAM token for API authentication and put it into the environment variable:

    export IAM_TOKEN="<IAM_token>"
    
  2. Clone the cloudapi repository:

    cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
    

    Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

  3. Use the ClusterService.Get call and send the following request, e.g., via gRPCurl:

    grpcurl \
        -format json \
        -import-path ~/cloudapi/ \
        -import-path ~/cloudapi/third_party/googleapis/ \
        -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
        -rpc-header "Authorization: Bearer $IAM_TOKEN" \
        -d '{
              "cluster_id": "<cluster_ID>"
            }' \
        mdb.api.cloud.yandex.net:443 \
        yandex.cloud.mdb.clickhouse.v1.ClusterService.Get
    

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

  4. View the server response to make sure the request was successful.

Viewing operations with clustersViewing operations with clusters

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

Getting a list of operationsGetting a list of operations

Management console
CLI
REST API
gRPC API

To view operations with all Managed Service for ClickHouse® 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 ClickHouse.

  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 CLI yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. 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 ClickHouse® cluster, run this command:

yc managed-clickhouse cluster list-operations <cluster_name_or_ID>

Result:

+----------------------+---------------------+----------------------+---------------------+--------+--------------------------------+
|          ID          |     CREATED AT      |      CREATED BY      |     MODIFIED AT     | STATUS |          DESCRIPTION           |
+----------------------+---------------------+----------------------+---------------------+--------+--------------------------------+
| c5m7ll6pq3j8******** | 2024-08-08 19:05:42 | mdb-maintainer       | 2024-08-15 19:20:05 | DONE   | Modify ClickHouse cluster      |
| c5mb0no66172******** | 2024-06-19 12:48:40 | mdb-maintainer       | 2024-06-26 12:50:14 | DONE   | Modify ClickHouse cluster      |
| c5m9hvmb3lg9******** | 2024-01-17 08:05:16 | ajeef73j5iq9******** | 2024-01-17 08:14:59 | DONE   | Add ZooKeeper to ClickHouse    |
|                      |                     |                      |                     |        | cluster                        |
| c5mniao7leml******** | 2023-11-13 19:34:54 | ajeef73j5iq9******** | 2023-11-13 19:35:10 | DONE   | Update user in ClickHouse      |
|                      |                     |                      |                     |        | cluster                        |
| c5m6of9he7op******** | 2023-11-13 19:25:21 | ajeef73j5iq9******** | 2023-11-13 19:32:00 | DONE   | Create ClickHouse 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-clickhouse cluster list-operations epdplu8jn7sr******** --format yaml

Result:

- id: c5m7ll6pq3j8********
  description: Modify ClickHouse cluster
  created_at: "2024-08-08T19:05:42.362668Z"
  created_by: mdb-maintainer
  modified_at: "2024-08-15T19:20:05.917268Z"
  done: true
  metadata:
    '@type': type.googleapis.com/yandex.cloud.mdb.clickhouse.v1.UpdateClusterMetadata
    cluster_id: c9q7vuuoiqml********
  response:
    '@type': type.googleapis.com/google.rpc.Status
    message: OK
...
  1. Get an IAM token for API authentication and put it into the environment variable:

    export IAM_TOKEN="<IAM_token>"
    
  2. Use the Cluster.ListOperations method and send the following request, e.g., via cURL:

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

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

  3. View the server response to make sure the request was successful.

  1. Get an IAM token for API authentication and put it into the environment variable:

    export IAM_TOKEN="<IAM_token>"
    
  2. Clone the cloudapi repository:

    cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
    

    Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

  3. Use the ClusterService.ListOperations call and send the following request, e.g., via gRPCurl:

    grpcurl \
        -format json \
        -import-path ~/cloudapi/ \
        -import-path ~/cloudapi/third_party/googleapis/ \
        -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
        -rpc-header "Authorization: Bearer $IAM_TOKEN" \
        -d '{
              "cluster_id": "<cluster_ID>"
            }' \
        mdb.api.cloud.yandex.net:443 \
        yandex.cloud.mdb.clickhouse.v1.ClusterService.ListOperations
    

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

  4. View the server response to make sure the request was successful.

Getting detailed information about an operationGetting detailed information about an operation

  1. Get a list of operations for a cluster.

  2. Copy the operation ID.

  3. Get detailed information about the operation:

    CLI
    REST API
    gRPC API

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

    The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

    Run this command:

    yc operation get <operation_ID>
    

    Result:

    id: c5m6of9he7op********
    description: Create ClickHouse cluster
    created_at: "2023-11-13T19:25:21.762164Z"
    created_by: ajeef73j5iq9********
    modified_at: "2023-11-13T19:32:00.464591Z"
    done: true
    metadata:
      '@type': type.googleapis.com/yandex.cloud.mdb.clickhouse.v1.CreateClusterMetadata
      cluster_id: c9q7vuuoiqml********
    response:
      '@type': type.googleapis.com/yandex.cloud.mdb.clickhouse.v1.Cluster
    ...
    
    1. Get an IAM token for API authentication and put it into the environment variable:

      export IAM_TOKEN="<IAM_token>"
      
    2. Use the Operation.Get method and send the following request, e.g., via cURL:

      curl \
          --request GET \
          --header "Authorization: Bearer $IAM_TOKEN" \
          --url 'https://operation.api.cloud.yandex.net/operations/<operation_ID>'
      
    3. View the server response to make sure the request was successful.

    1. Get an IAM token for API authentication and put it into the environment variable:

      export IAM_TOKEN="<IAM_token>"
      
    2. Clone the cloudapi repository:

      cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
      

      Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

    3. Use the OperationService.Get call and send the following request, e.g., via 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_ID>"
              }' \
          operation.api.cloud.yandex.net:443 \
          yandex.cloud.operation.OperationService.Get
      
    4. View the server response to make sure the request was successful.

See alsoSee also

  • Working with operations

ClickHouse® is a registered trademark of ClickHouse, Inc.

Was the article helpful?

Previous
All guides
Next
Creating a cluster
Yandex project
© 2025 Yandex.Cloud LLC