Information about existing ClickHouse® clusters
You can request detailed information about each Managed Service for ClickHouse® cluster you created.
Getting a list of database clusters in a folder
In the management console
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 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 |
| ... |
+----------------------+------+-------------+---------+---------------------+--------+---------+
-
Get an IAM token for API authentication and place it in the environment variable:
export IAM_TOKEN="<IAM_token>"
-
Use the Cluster.list method and make a request, e.g., via cURL
:curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters?folderId=<folder_ID>'
You can request the folder ID with a list of folders in the cloud.
-
View the server response to make sure the request was successful.
-
Get an IAM token for API authentication and place it in the 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 the repository contents are stored in the
~/cloudapi/
directory. -
Use the ClusterService/List call and make a 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 a list of folders in the cloud.
-
View the server response to make sure the request was successful.
Getting detailed information about a cluster
- In the management console
, go to the folder page and select Managed Service for ClickHouse. - 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 a 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.
-
Get an IAM token for API authentication and place it in the environment variable:
export IAM_TOKEN="<IAM_token>"
-
Use the Cluster.get method and make a 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.
-
View the server response to make sure the request was successful.
-
Get an IAM token for API authentication and place it in the 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 the repository contents are stored in the
~/cloudapi/
directory. -
Use the ClusterService/Get call and make a 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.
-
View the server response to make sure the request was successful.
Viewing 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 operations
To view operations with all Managed Service for ClickHouse® clusters, in the left-hand panel, select
You can get a list of operations for a cluster:
-
In the management console
, open the folder with the cluster. -
Select Managed Service for ClickHouse.
-
In the left-hand panel, select
Clusters. -
Select the cluster you need.
-
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 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
...
-
Get an IAM token for API authentication and place it in the environment variable:
export IAM_TOKEN="<IAM_token>"
-
Use the Cluster.listOperations method and make a 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.
-
View the server response to make sure the request was successful.
-
Get an IAM token for API authentication and place it in the 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 the repository contents are stored in the
~/cloudapi/
directory. -
Use the ClusterService/ListOperations call and make a 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.
-
View the server response to make sure the request was successful.
Getting detailed information about an operation
-
Get a list of operations for a cluster.
-
Copy the ID of the operation.
-
Get detailed information about the operation:
CLIAPIIf 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: 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 ...
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
ClickHouse® is a registered trademark of ClickHouse, Inc