Информация об имеющихся кластерах ClickHouse®
Вы можете запросить детальную информацию о каждом созданном вами кластере Managed Service for ClickHouse®.
Получить список кластеров БД в каталоге
В консоли управления
Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.
По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name
или --folder-id
.
Чтобы запросить список кластеров ClickHouse® в каталоге по умолчанию, выполните команду:
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 |
| ... |
+----------------------+------+-------------+---------+---------------------+--------+---------+
-
Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
export IAM_TOKEN="<IAM-токен>"
-
Воспользуйтесь методом Cluster.list и выполните запрос, например, с помощью cURL
:curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters' \ --url-query folderId=<идентификатор_каталога>
Идентификатор каталога можно запросить со списком каталогов в облаке.
-
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.
-
Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
export IAM_TOKEN="<IAM-токен>"
-
Клонируйте репозиторий cloudapi
:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
Далее предполагается, что содержимое репозитория находится в директории
~/cloudapi/
. -
Воспользуйтесь вызовом ClusterService/List и выполните запрос, например, с помощью 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": "<идентификатор_каталога>" }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.clickhouse.v1.ClusterService.List
Идентификатор каталога можно запросить со списком каталогов в облаке.
-
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.
Получить детальную информацию о кластере
- В консоли управления
перейдите на страницу каталога и выберите сервис Managed Service for ClickHouse. - Нажмите на имя нужного кластера.
Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.
По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name
или --folder-id
.
Чтобы получить информацию о кластере ClickHouse®, выполните команду:
yc managed-clickhouse cluster get <имя_или_идентификатор_кластера>
Идентификатор и имя кластера можно запросить со списком кластеров в каталоге.
-
Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
export IAM_TOKEN="<IAM-токен>"
-
Воспользуйтесь методом Cluster.get и выполните запрос, например, с помощью cURL
:curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<идентификатор_кластера>'
Идентификатор кластера можно запросить со списком кластеров в каталоге.
-
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.
-
Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
export IAM_TOKEN="<IAM-токен>"
-
Клонируйте репозиторий cloudapi
:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
Далее предполагается, что содержимое репозитория находится в директории
~/cloudapi/
. -
Воспользуйтесь вызовом ClusterService/Get и выполните запрос, например, с помощью 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": "<идентификатор_кластера>" }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.clickhouse.v1.ClusterService.Get
Идентификатор кластера можно запросить со списком кластеров в каталоге.
-
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.
Посмотреть операции с кластерами
Все действия с кластерами Managed Service for ClickHouse® сохраняются в виде списка операций. Каждой операции присваивается уникальный идентификатор.
Получить список операций
Чтобы посмотреть операции со всеми кластерами Managed Service for ClickHouse®, на панели слева выберите
Можно получить список операций для кластера:
-
В консоли управления
откройте каталог, в котором находится кластер. -
Выберите сервис Managed Service for ClickHouse.
-
На панели слева выберите
Кластеры. -
Выберите нужный кластер.
-
Перейдите на панель
Операции для выбранного кластера.В открывшемся списке отображаются операции с выбранным кластером.
Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.
По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name
или --folder-id
.
Чтобы получить список операций для кластера Managed Service for ClickHouse®, воспользуйтесь командой:
yc managed-clickhouse cluster list-operations <имя_или_идентификатор_кластера>
Результат:
+----------------------+---------------------+----------------------+---------------------+--------+--------------------------------+
| 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 |
+----------------------+---------------------+----------------------+---------------------+---- ---+--------------------------------+
Идентификатор и имя кластера можно получить, запросив список кластеров в каталоге.
По умолчанию информация об операциях выводится в текстовом формате. Чтобы получить более подробную информацию, укажите формат yaml
или json
для выводимых данных с помощью флага --format
:
yc managed-clickhouse cluster list-operations epdplu8jn7sr******** --format yaml
Результат:
- 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
...
-
Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
export IAM_TOKEN="<IAM-токен>"
-
Воспользуйтесь методом Cluster.listOperations и выполните запрос, например, с помощью cURL
:curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<идентификатор_кластера>/operations'
Идентификатор кластера можно получить со списком кластеров в каталоге.
-
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.
-
Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
export IAM_TOKEN="<IAM-токен>"
-
Клонируйте репозиторий cloudapi
:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
Далее предполагается, что содержимое репозитория находится в директории
~/cloudapi/
. -
Воспользуйтесь вызовом ClusterService/ListOperations и выполните запрос, например, с помощью 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": "<идентификатор_кластера>" }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.clickhouse.v1.ClusterService.ListOperations
Идентификатор кластера можно получить со списком кластеров в каталоге.
-
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.
Получить подробную информацию об операции
-
Получите список операций для кластера.
-
Скопируйте идентификатор нужной операции.
-
Получите подробную информацию об операции:
CLIAPIЕсли у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.
По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра
--folder-name
или--folder-id
.Выполните команду:
yc operation get <идентификатор_операции>
Результат:
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 ...
Воспользуйтесь методом REST API get для ресурса Operation или вызовом gRPC API OperationService/Get и передайте в запросе идентификатор операции.
См. также
ClickHouse® является зарегистрированным товарным знаком ClickHouse, Inc