Управление кластером

Получить список кластеров

Веб-консоль
MWS CLI
API

В веб-консоли выберите нужный проект.
В списке сервисов выберите Managed ClickHouse.

Откроется список кластеров проекта.

Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.

Выполните команду:

1
mws mclickhouse cluster list

1
+----------------+-------------+------------+----------------------+
2
|      NAME      | DESCRIPTION |   STATUS   |      UPDATE TIME     |
3
+----------------+-------------+------------+----------------------+
4
| <имя кластера> |             | PROCESSING | 2025-11-27T13:18:24Z |
5
+----------------+-------------+------------+----------------------+

Убедитесь, что у вас есть IAM-токен для авторизации запроса. Если нет, получите его.
Выполните запрос:
bash
```
1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters \
2
  -H "Authorization: Bearer <IAM-токен>"
```
Если запрос был успешно принят, вы получите ответ с кодом 200 OK. В ответе будет выведен список доступных кластеров проекта с детализацией параметров.

Получить информацию о конкретном кластере

Веб-консоль
MWS CLI
API

В веб-консоли выберите нужный проект.
В списке сервисов выберите Managed ClickHouse.
Нажмите на имя нужного кластера.

Откроется страница кластера.

Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.
Узнайте имя кластера:
bash
```
1
mws mclickhouse cluster list
```

Получите информацию о кластере:

1
mws mclickhouse cluster get <имя кластера>

1
kind: mclickhouse/v1/cluster
2
metadata:
3
    displayName: <отображаемое имя кластера>
4
    createTime: "<дата и время создания кластера>"
5
    updateTime: "<дата и время последнего изменения кластера>"
6
    description: "<описание кластера>"
7
    id: mclickhouse/projects/<имя проекта>/clusters/<имя кластера>
8
spec:
9
    active: true
10
    version: "<версия ClickHouse>"
11
    coordinator:
12
        resources:
13
            vmType: <тип ВМ>
14
            disk:
15
                size: <размер диска в гигабайтах>
16
                type: <тип диска>
17
        instances:
18
            - count: <количество узлов ClickHouse Keeper в зоне доступности 1>
19
            zone: <зона доступности 1>
20
            - count: <количество узлов ClickHouse Keeper в зоне доступности 2>
21
            zone: <зона доступности 2>
22
    shards:
23
        - name: <имя шарда — sh1>
24
        resources:
25
            vmType: <тип ВМ>
26
            disk:
27
                size: <размер диска в гигабайтах>
28
                type: <тип диска>
29
        instances:
30
            - count: <количество узлов в зоне доступности>
31
            zone: <зона доступности>
32
            endpoints:
33
                - address:
34
                    spec:
35
                        subnet: vpc/projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>
36
    bootstrapAdmin:
37
        username: <имя администратора кластера>
38
    backup:
39
        hour: <время начала резервного копирования>
40
        retainPeriodDays: <срок хранения резервных копий в днях>
41
    maintenanceWindow:
42
        weekly:
43
            days:
44
                - <день для сервисного окна>
45
            hour: <время начала сервисного окна>
46
status:
47
    ready:
48
        state: PROCESSING
49
    health: <состояние кластера>
50
    state: <статус кластера>
51
    cluster:
52
        active: <состояние кластера: true — запущен, false — остановлен>
53
        version: "<версия ClickHouse>"
54
        endpoints:
55
            - address:
56
                ref: projects/<имя проекта>/networks/<имя сети>/addresses/**-****************c82m1f292zhh27xtezuaupd4k3vgfn5ryq
57
                subnet: projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>
58
                ipAddress: 10.0.*.**
59
                dns:
60
                    - name: <имя узла>.<имя шарда — sh1>.<имя кластера>.mclickhouse.mws
61
        shards:
62
            - id: projects/<имя проекта>/clusters/<имя кластера>/shards/<имя шарда — sh1>
63
            name: <имя шарда — sh1>
64
            weight: 1
65
            resources:
66
                vmType: <тип ВМ>
67
                disk:
68
                    size: <размер диска в гигабайтах>
69
                    type: <тип диска>
70
            instances:
71
                - id: projects/<имя проекта>/clusters/<имя кластера>/shards/<имя шарда — sh1>/instances/<имя узла>
72
                zone: <зона доступности>
73
                endpoints:
74
                    - address:
75
                        ref: projects/<имя проекта>/networks/<имя сети>/addresses/**-****************c82m1f292zhh27xtezuaupd4k3vgfn5ryq
76
                        subnet: projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>
77
                        ipAddress: 10.0.*.**
78
                        dns:
79
                            - name: <имя узла>.<имя шарда — sh1>.<имя кластера>.mclickhouse.mws
80
                health: <состояние узла>
81
        maintenanceWindow:
82
            weekly:
83
                days:
84
                    - <день для сервисного окна>
85
                hour: <время начала сервисного окна>
86
        backup:
87
            hour: <время начала резервного копирования>
88
            retainPeriodDays: <срок хранения резервных копий в днях>

Убедитесь, что у вас есть IAM-токен для авторизации запроса. Если нет, получите его.

Узнайте имя кластера:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters \
2
  -H "Authorization: Bearer <IAM-токен>"

Получите информацию о кластере:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>"

1
{
2
  "kind" : "mclickhouse/v1/cluster",
3
  "metadata" : {
4
    "displayName" : "<отображаемое имя кластера>",
5
    "createTime" : "<дата и время создания кластера>",
6
    "updateTime" : "<дата и время последнего изменения кластера>",
7
    "description" : "<описание кластера>",
8
    "id" : "mclickhouse/projects/<имя проекта>/clusters/<имя кластера>"
9
  },
10
  "spec" : {
11
    "active" : <состояние кластера: true — запущен, false — остановлен>,
12
    "version" : "<версия ClickHouse>",
13
    "shards" : [ {
14
      "name" : "<имя шарда — sh1>",
15
      "resources" : {
16
        "vmType" : "<тип ВМ>",
17
        "disk" : {
18
          "size" : "<размер диска в гигабайтах>",
19
          "type" : "<тип диска>"
20
        }
21
      },
22
      "instances" : [ {
23
        "count" : 1,
24
        "zone" : "<зона доступности>",
25
        "endpoints" : [ {
26
          "address" : {
27
            "spec" : {
28
              "subnet" : "vpc/projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>"
29
            }
30
          }
31
        } ]
32
      } ]
33
    } ],
34
    "bootstrapAdmin" : {
35
      "username" : "<имя администратора кластера>"
36
    },
37
    "backup" : {
38
      "hour" : <время начала резервного копирования>,
39
      "retainPeriodDays" : <срок хранения резервных копий в днях>
40
    },
41
    "maintenanceWindow" : {
42
      "weekly" : {
43
        "days" : [ "<день для сервисного окна>" ],
44
        "hour" : <время начала сервисного окна>
45
      }
46
    }
47
  },
48
  "status" : {
49
    "ready" : {
50
      "state" : "PROCESSING",
51
    },
52
    "health" : "<состояние кластера>",
53
    "state" : "статус кластера>",
54
    "cluster" : {
55
      "active" : <состояние кластера: true — запущен, false — остановлен>,
56
      "version" : "<версия ClickHouse>",
57
      "endpoints" : [ {
58
        "address" : {
59
          "ref" : "projects/<имя проекта>/networks/<имя сети>/addresses/**-****************c82m1f292zhh27xtezuaupd4k3vgfn5ryq",
60
          "subnet" : "projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>",
61
          "ipAddress" : "10.0.*.**",
62
          "dns" : [ {
63
            "name" : "<имя узла>.<имя шарда — sh1>.<имя кластера>.mclickhouse.mws"
64
          } ]
65
        }
66
      } ],
67
      "shards" : [ {
68
        "id" : "projects/<имя проекта>/clusters/<имя кластера>/shards/<имя шарда — sh1>",
69
        "name" : "<имя шарда — sh1>",
70
        "weight" : 1,
71
        "resources" : {
72
          "vmType" : "<тип ВМ>",
73
          "disk" : {
74
            "size" : "<размер диска в гигабайтах>",
75
            "type" : "<тип диска>"
76
          },
77
          "gracefulShutdownTimeout" : "<длительность graceful shutdown в секундах>"
78
        },
79
        "instances" : [ {
80
          "id" : "projects/<имя проекта>/clusters/<имя кластера>/shards/<имя шарда — sh1>/instances/<имя узла>",
81
          "zone" : "<зона доступности>",
82
          "endpoints" : [ {
83
            "address" : {
84
              "ref" : "projects/<имя проекта>/networks/<имя сети>/addresses/**-****************c82m1f292zhh27xtezuaupd4k3vgfn5ryq",
85
              "subnet" : "projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>",
86
              "ipAddress" : "10.0.*.**",
87
              "dns" : [ {
88
                "name" : "<имя узла>.<имя шарда — sh1>.<имя кластера>.mclickhouse.mws"
89
              } ]
90
            }
91
          } ],
92
          "health" : "<состояние узла>"
93
        } ]
94
      } ],
95
      "maintenanceWindow" : {
96
        "weekly" : {
97
          "days" : [ "<день для сервисного окна>" ],
98
          "hour" : <время начала сервисного окна>
99
        }
100
      }
101
    }
102
  }
103
}

Если запрос был успешно принят, вы получите ответ с кодом 200 OK. В ответе будут выведены параметры кластера с детализацией.

Переименовать кластер

Вы можете изменить только отображаемое имя кластера. Идентификатор кластера при этом не изменится.

Веб-консоль
MWS CLI
API

В веб-консоли выберите нужный проект.
В списке сервисов выберите Managed ClickHouse.
Нажмите на значок ... для нужного кластера и выберите Переименовать.
Укажите новое отображаемое имя кластера и нажмите кнопку Сохранить.

Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.
Узнайте имя кластера:
bash
```
1
mws mclickhouse cluster list
```
Переименуйте кластер:
bash
```
1
mws mclickhouse cluster update <имя кластера> --display-name <новое отображаемое имя кластера>
```
Если кластер был переименован успешно, в ответе будут выведены обновленные параметры кластера.

Убедитесь, что у вас есть IAM-токен для авторизации запроса. Если нет, получите его.

Узнайте имя кластера:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters \
2
  -H "Authorization: Bearer <IAM-токен>"

Переименуйте кластер:

1
curl -X POST https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>" \
3
  -H "Content-Type: application/json" \
4
  -d '{
5
        "metadata": {
6
          "displayName": "<новое отображаемое имя кластера>"
7
        }
8
      }'

Если кластер был переименован успешно, вы получите ответ с кодом 200 OK и обновленными параметрами кластера.

Изменить пароль администратора

Веб-консоль
MWS CLI
API

В веб-консоли выберите нужный проект.
В списке сервисов выберите Managed ClickHouse.
Нажмите на имя нужного кластера.
Нажмите кнопку Задать новый пароль.
Задайте вручную или сгенерируйте новый пароль.
Нажмите кнопку Сохранить.
Сохраните новый пароль локально или в Secret Manager. За использование сервиса Secret Manager взимается плата.

Не закрывайте окно, пока не сохраните пароль: позже доступа к паролю не будет.

Чтобы сохранить пароль в Secret Manager:
1. Нажмите на строку Сохранить пароль в Secret Manager.
2. Сохраните учетные данные одним из способов:
  В новом секрете
  В существующем секрете
  
  На вкладке Новый нажмите кнопку Создать секрет.
  
  Откроется страница создания секрета.
  
  (опционально) Измените автоматически сгенерированное имя секрета. Позже это имя (name) и созданный из него идентификатор (ID) секрета нельзя изменить, меняется только отображаемое имя (display name) секрета.
  
  (опционально) Чтобы использовать для шифрования ключ KMS, выберите Пользовательский ключ, затем выберите нужный ключ KMS или создайте новый. По умолчанию используется Системный ключ, которым управляет MWS Cloud Platform.
  
  (опционально) Измените автоматически сгенерированное описание секрета.
  
  Нажмите кнопку Сохранить.
  
  Учетные данные администратора будут сохранены в первой версии секрета.
  
  Выбирайте существующий секрет, если хотите сохранить учетные данные администратора вместе со значениями из текущей версии секрета. Новая версия станет текущей, а предыдущие версии сохранятся.
  
  Перейдите на вкладку Существующий.
  
  Выберите нужный секрет и нажмите кнопку Сохранить в новой версии секрета.
  
  Проверьте содержимое новой версии. Значения текущей версии секрета будут перенесены в нее. Если в текущей версии нет пар с ключами username и password, они будут добавлены. Если такие пары есть, их значения будут заменены именем администратора и новым паролем.
  
  Нажмите кнопку Создать.
  
  Учетные данные администратора будут сохранены в новой версии выбранного секрета.

Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.
Узнайте имя кластера:
bash
```
1
mws mclickhouse cluster list
```
Измените пароль:
bash
```
1
mws mclickhouse cluster update <имя кластера> \
2
  --bootstrap-admin-password <новый пароль администратор кластера>
```
Если пароль был изменен успешно, в ответе будут выведены обновленные параметры кластера.

Убедитесь, что у вас есть IAM-токен для авторизации запроса. Если нет, получите его.

Узнайте имя кластера:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters \
2
  -H "Authorization: Bearer <IAM-токен>"

Измените пароль:

1
curl -X POST https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>" \
3
  -H "Content-Type: application/json" \
4
  -d '{
5
        "spec": {
6
          "bootstrapAdmin": {
7
              "password": "<пароль администратора кластера>"
8
          }
9
        }
10
      }'

Если пароль был изменен успешно, вы получите ответ с кодом 200 OK и обновленными параметрами кластера.

Изменить топологию кластера

Топологию кластера можно изменить: добавить узлы и шарды. Общее число шардов и узлов, а также число узлов в одном шарде нельзя уменьшить.

MWS CLI
API

Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.
Узнайте имя кластера:
bash
```
1
mws mclickhouse cluster list
```

Передайте в команде изменения кластера описание новой топологии кластера:

1
mws mclickhouse cluster update <имя кластера> --shards '
2
  <описание топологии>
3
'

Примеры описания топологий:

1
name: sh1
2
resources:
3
  vmType: <тип ВМ — например, vmTypes/gen-4-8>
4
  disk:
5
    size: <размер диска в гигабайтах — например, 20GB>
6
    type: <тип диска — NETWORK_STANDARD_SSD>
7
weight: 1
8
instances:
9
  - zone: ru-central1-a
10
    count: <количество узлов в зоне доступности ru-central1-a — 1>
11
    endpoints:
12
      - address:
13
          spec:
14
            subnet: projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>
15
  - zone: ru-central1-b
16
    count: <количество узлов в зоне доступности ru-central1-b — 1>
17
    endpoints:
18
      - address:
19
          spec:
20
            subnet: projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>

Каждый шард передается в флаг --shards по отдельности.

1
name: sh1
2
resources:
3
  vmType: <тип ВМ — например, vmTypes/gen-4-8>
4
  disk:
5
    size: <размер диска в гигабайтах — например, 20GB>
6
    type: <тип диска — NETWORK_STANDARD_SSD>
7
weight: 1
8
instances:
9
  - zone: ru-central1-a
10
    count: <количество узлов в зоне доступности ru-central1-a — 1>
11
    endpoints:
12
      - address:
13
          spec:
14
            subnet: projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>
15
  - zone: ru-central1-b
16
    count: <количество узлов в зоне доступности ru-central1-b — 1>
17
    endpoints:
18
      - address:
19
          spec:
20
            subnet: projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>

1
name: sh2
2
resources:
3
  vmType: <тип ВМ — например, vmTypes/gen-4-8>
4
  disk:
5
    size: <размер диска в гигабайтах — например, 20GB>
6
    type: <тип диска — NETWORK_STANDARD_SSD>
7
weight: 1
8
instances:
9
  - zone: ru-central1-a
10
    count: <количество узлов в зоне доступности ru-central1-a — 1>
11
    endpoints:
12
      - address:
13
          spec:
14
            subnet: projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>
15
  - zone: ru-central1-b
16
    count: <количество узлов в зоне доступности ru-central1-b — 1>
17
    endpoints:
18
      - address:
19
          spec:
20
            subnet: projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>

Если топология была изменена успешно, в ответе будут выведены обновленные параметры кластера.

Убедитесь, что у вас есть IAM-токен для авторизации запроса. Если нет, получите его.

Узнайте имя кластера:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters \
2
  -H "Authorization: Bearer <IAM-токен>"

Передайте в запросе описание новой топологии кластера:

1
curl -X POST https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>" \
3
  -H "Content-Type: application/json" \
4
  -d '{
5
        "spec": {
6
          "shards": [ <описание топологии> ]
7
        }
8
      }'

Примеры описания топологий:

1
 "spec": {
2
    "shards": [
3
      {
4
        "name": "sh1",
5
        "resources": {
6
          "vmType": "<тип ВМ — например, vmTypes/gen-4-8>",
7
          "disk": {
8
            "size": "<размер диска в гигабайтах — например, 20GB>",
9
            "type": "<тип диска — NETWORK_STANDARD_SSD>"
10
          }
11
        },
12
        "weight": 1,
13
        "instances": [
14
          {
15
            "zone": "ru-central1-a",
16
            "count": <количество узлов в зоне доступности ru-central1-a — 1>,
17
            "endpoints": [
18
              {
19
                "address": {
20
                  "spec": {
21
                    "subnet": "projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>"
22
                  }
23
                }
24
              }
25
            ]
26
          },
27
          {
28
            "zone": "ru-central1-b",
29
            "count": <количество узлов в зоне доступности ru-central1-b — 1>,
30
            "endpoints": [
31
              {
32
                "address": {
33
                  "spec": {
34
                    "subnet": "projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>"
35
                  }
36
                }
37
              }
38
            ]
39
          }
40
        ]
41
      }
42
    ]
43
  }

1
 "spec": {
2
    "shards": [
3
      {
4
        "name": "sh1",
5
        "resources": {
6
          "vmType": "<тип ВМ — например, vmTypes/gen-4-8>",
7
          "disk": {
8
            "size": "<размер диска в гигабайтах — например, 20GB>",
9
            "type": "<тип диска — NETWORK_STANDARD_SSD>"
10
          }
11
        },
12
        "weight": 1,
13
        "instances": [
14
          {
15
            "zone": "ru-central1-a",
16
            "count": <количество узлов в зоне доступности ru-central1-a — 1>,
17
            "endpoints": [
18
              {
19
                "address": {
20
                  "spec": {
21
                    "subnet": "projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>"
22
                  }
23
                }
24
              }
25
            ]
26
          },
27
          {
28
            "zone": "ru-central1-b",
29
            "count": <количество узлов в зоне доступности ru-central1-b — 1>,
30
            "endpoints": [
31
              {
32
                "address": {
33
                  "spec": {
34
                    "subnet": "projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>"
35
                  }
36
                }
37
              }
38
            ]
39
          }
40
        ]
41
      },
42
      {
43
        "name": "sh2",
44
        "resources": {
45
          "vmType": "<тип ВМ — например, vmTypes/gen-4-8>",
46
          "disk": {
47
            "size": "<размер диска в гигабайтах — например, 20GB>",
48
            "type": "<тип диска — NETWORK_STANDARD_SSD>"
49
          }
50
        },
51
        "weight": 1,
52
        "instances": [
53
          {
54
            "zone": "ru-central1-a",
55
            "count": <количество узлов в зоне доступности ru-central1-a — 1>,
56
            "endpoints": [
57
              {
58
                "address": {
59
                  "spec": {
60
                    "subnet": "projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>"
61
                  }
62
                }
63
              }
64
            ]
65
          },
66
          {
67
            "zone": "ru-central1-b",
68
            "count": <количество узлов в зоне доступности ru-central1-b — 1>,
69
            "endpoints": [
70
              {
71
                "address": {
72
                  "spec": {
73
                    "subnet": "projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>"
74
                  }
75
                }
76
              }
77
            ]
78
          }
79
        ]
80
      }
81
    ]
82
  }

Если топология была изменена успешно, вы получите ответ с кодом 200 OK и обновленными параметрами кластера.

Настроить внешние IP-адреса

Назначить внешние IP-адреса

В кластере Managed ClickHouse можно назначить внешние IP-адреса следующим эндпоинтам:

эндпоинт кластера — для подключения к случайному активному узлу кластера;
эндпоинт шарда — для подключения к случайному активному узлу шарда;
эндпоинт узла — для подключения к конкретному узлу.

Эндпоинты для подключения к шардам и узлам объединены в группы. Все эндпоинты в группе могут иметь IP-адреса только одного типа.

Временные внешние IP-адреса можно сменить только на зарезервированные.

Веб-консоль
MWS CLI
API

В веб-консоли выберите нужный проект.
В списке сервисов выберите Managed ClickHouse.
Нажмите на имя нужного кластера.
Перейдите на вкладку Сети.
Над списком эндпоинтов нажмите на значок ... → Редактировать.
Определите, какой группе эндпоинтов нужно назначить внешний IP-адрес: кластеру, шардам или узлам.
Выберите тип IP-адреса: временный, который выбирается автоматически из диапазона подсети, или зарезервированный. Выбранный тип адреса применится ко всем объектам в группе шардов или узлов.
Если вы выбрали зарезервированный адрес, для каждого объекта в группе нажмите на значок редактирования и назначьте IP-адрес. Если IP-адреса еще не зарезервированы, зарезервируйте их.
Нажмите кнопку Сохранить.

Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.
Узнайте имя кластера:
bash
```
1
mws mclickhouse cluster list
```
Получите информацию о кластере — идентификатор подсети, а также имена узлов или шардов, для которых назначаются внешние IP-адреса:
bash
```
1
mws mclickhouse cluster get <имя кластера>
```
Если вы назначаете зарезервированные IP-адреса, узнайте их идентификаторы:
bash
```
1
mws vpc external-address get <имя адреса>
```

Выполните команду для нужной группы эндпоинтов:

Кластер
Шарды
Узлы

1
mws mclickhouse cluster update <имя кластера> --endpoints '
2
address:
3
  spec:
4
    subnet: <идентификатор подсети>
5
externalAddress:
6
  # Для назначения временного IP
7
  spec:
8
    subnet: <идентификатор подсети>
9
  # Для назначения зарезервированного IP
10
  ref: <идентификатор зарезервированного IP>
11
'

1
mws mclickhouse cluster update <имя кластера> --shards '
2
name: <имя шарда>
3
endpoints:
4
  - address:
5
      spec:
6
        subnet: <идентификатор подсети>
7
    externalAddress:
8
    # Для назначения временного IP
9
      spec:
10
        subnet: <идентификатор подсети>
11
    # Для назначения зарезервированного IP
12
      ref: <идентификатор зарезервированного IP>
13
'  # --shards ...

Перечислите все шарды по одному во флагах --shards.

1
mws mclickhouse cluster update <имя кластера> --shards '
2
name: <имя шарда>
3
instances:
4
  - name: <имя узла>
5
    zone: <зона доступности узла>
6
    endpoints:
7
      - address:
8
          spec:
9
            subnet: <идентификатор подсети>
10
        externalAddress:
11
        # Для назначения временного IP
12
          spec:
13
            subnet: <идентификатор подсети>
14
        # Для назначения зарезервированного IP
15
          ref: <идентификатор зарезервированного IP>
16
  # - name: ...
17
'  # --shards ...

Перечислите все шарды по одному во флагах --shards и все соответствующие шардам узлы в списках instances.

Убедитесь, что у вас есть IAM-токен для авторизации запроса. Если нет, получите его.

Узнайте имя кластера:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters \
2
  -H "Authorization: Bearer <IAM-токен>"

Получите информацию о кластере — идентификатор подсети, а также имена узлов или шардов, для которых назначаются внешние IP-адреса:
bash
```
1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>"
```

Если вы назначаете зарезервированные IP-адреса, узнайте их идентификаторы:

1
curl -X GET https://vpc.mwsapis.ru/vpc/v1/projects/<имя проекта>/networks/<имя сети>/addresses \
2
  -H "Authorization: Bearer <IAM-токен>"

Выполните запрос для нужной группы эндпоинтов:

Кластер
Шарды
Узлы

1
curl -X POST https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>" \
3
  -H "Content-Type: application/json" \
4
  -d '{
5
        "spec": {
6
          "endpoints": [{
7
            "address": {
8
              "spec": {
9
                "subnet": "<идентификатор подсети>"
10
              }
11
            },
12
            "externalAddress": {
13
            // Для назначения временного IP
14
              "spec": {
15
                "subnet": "<идентификатор подсети>"
16
              }
17
            // Для назначения зарезервированного IP
18
              "ref": "<идентификатор зарезервированного IP>"
19
            }
20
          }]
21
        }
22
      }'

1
curl -X POST https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>" \
3
  -H "Content-Type: application/json" \
4
  -d '{
5
        "spec": {
6
          "shards":
7
          [
8
            {
9
              "name": "<имя шарда>",
10
              "endpoints": [{
11
                "address": {
12
                  "spec": {
13
                    "subnet": "<идентификатор подсети>"
14
                  }
15
                },
16
                "externalAddress": {
17
                // Для назначения временного IP
18
                  "spec": {
19
                    "subnet": "<идентификатор подсети>"
20
                  }
21
                // Для назначения зарезервированного IP
22
                  "ref": "<идентификатор зарезервированного IP>"
23
                }
24
              }]
25
            }, ...
26
          ]
27
        }
28
      }'

Перечислите все шарды в списке shards.

1
curl -X POST https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>" \
3
  -H "Content-Type: application/json" \
4
  -d '{
5
        "spec": {
6
          "shards":
7
          [
8
            {
9
              "name": "<имя шарда>",
10
              "instances": [
11
                {
12
                  "name": "<имя узла>",
13
                  "zone": "<зона доступности узла>",
14
                  "endpoints": [{
15
                    "address": {
16
                      "spec": {
17
                        "subnet": "<идентификатор подсети>"
18
                      }
19
                    },
20
                    "externalAddress": {
21
                    // Для назначения временного IP
22
                      "spec": {
23
                        "subnet": "<идентификатор подсети>"
24
                      }
25
                    // Для назначения зарезервированного IP
26
                      "ref": "<идентификатор зарезервированного IP>"
27
                    }
28
                  }]
29
                }, ...
30
              ]
31
            }, ...
32
          ]
33
        }
34
      }'

Перечислите все шарды в списке shards и соответствующие шардам узлы в списках instances.

Отвязать внешние IP-адреса

Внешние IP-адреса отвязываются у всех эндпоинтов в группе эндпоинтов кластера.

Веб-консоль
MWS CLI
API

В веб-консоли выберите нужный проект.
В списке сервисов выберите Managed ClickHouse.
Нажмите на имя нужного кластера.
Перейдите на вкладку Сети.
Над списком эндпоинтов нажмите на значок ... → Редактировать.
Выберите нужную группу эндпоинтов.
Выберите тип IP-адреса Без адреса. Внешние IP-адреса будут отвязаны у всех объектов в группе узлов или шардов.
Нажмите кнопку Сохранить.

Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.
Узнайте имя кластера:
bash
```
1
mws mclickhouse cluster list
```
Получите информацию о кластере — идентификатор подсети, а также имена узлов или шардов, для которых назначаются внешние IP-адреса:
bash
```
1
mws mclickhouse cluster get <имя кластера>
```

Выполните команду для нужной группы эндпоинтов:

Кластер
Шарды
Узлы

1
mws mclickhouse cluster update <имя кластера> --endpoints '
2
address:
3
  spec:
4
    subnet: <идентификатор подсети>
5
externalAccess: false
6
'

1
mws mclickhouse cluster update <имя кластера> --shards '
2
name: <имя шарда>
3
endpoints:
4
  - address:
5
      spec:
6
        subnet: <идентификатор подсети>
7
    externalAccess: false
8
'  # --shards ...

Перечислите все шарды по одному во флагах --shards.

1
mws mclickhouse cluster update <имя кластера> --shards '
2
name: <имя шарда>
3
instances:
4
  - name: <имя узла>
5
    zone: <зона доступности узла>
6
    endpoints:
7
      - address:
8
          spec:
9
            subnet: <идентификатор подсети>
10
        externalAccess: false
11
 # - name: ...
12
'  # --shards ...

Перечислите все шарды по одному во флагах --shards и все соответствующие шардам узлы в списках instances.

Убедитесь, что у вас есть IAM-токен для авторизации запроса. Если нет, получите его.

Узнайте имя кластера:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters \
2
  -H "Authorization: Bearer <IAM-токен>"

Получите информацию о кластере — идентификатор подсети, а также имена узлов или шардов, для которых назначаются внешние IP-адреса:
bash
```
1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>"
```

Выполните запрос для нужной группы эндпоинтов:

Кластер
Шарды
Узлы

1
curl -X POST https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>" \
3
  -H "Content-Type: application/json" \
4
  -d '{
5
        "spec": {
6
          "endpoints": [{
7
            "address": {
8
              "spec": {
9
                "subnet": "<идентификатор подсети>"
10
              }
11
            },
12
            "externalAccess": false
13
          }]
14
        }
15
      }'

1
curl -X POST https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>" \
3
  -H "Content-Type: application/json" \
4
  -d '{
5
        "spec": {
6
          "shards": [
7
            {
8
              "name": "<имя шарда>",
9
              "endpoints": [
10
                {
11
                  "address": {
12
                    "spec": {
13
                      "subnet": "<идентификатор подсети>"
14
                    }
15
                  },
16
                  "externalAccess": false
17
                }
18
              ]
19
            }, ...
20
          ]
21
        }
22
      }'

Перечислите все шарды в списке shards.

1
curl -X POST https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>" \
3
  -H "Content-Type: application/json" \
4
  -d '{
5
        "spec": {
6
          "shards": [
7
            {
8
              "name": "<имя шарда>",
9
              "instances": [
10
                {
11
                  "name": "<имя узла>",
12
                  "zone": "<зона доступности узла>",
13
                  "endpoints": [
14
                    {
15
                      "address": {
16
                        "spec": {
17
                          "subnet": "<идентификатор подсети>"
18
                        }
19
                      },
20
                      "externalAccess": false
21
                    }
22
                  ]
23
                }, ...
24
              ]
25
            }, ...
26
          ]
27
        }
28
      }'

Перечислите все шарды в списке shards и соответствующие шардам узлы в списках instances.

Изменить конфигурацию узлов с данными

Веб-консоль
MWS CLI
API

В веб-консоли выберите нужный проект.
В списке сервисов выберите Managed ClickHouse.
Нажмите на имя нужного кластера.
Нажмите на значок редактирования для блока Конфигурация узла и измените конфигурацию.
Нажмите кнопку Сохранить.

Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.
Узнайте имя кластера:
bash
```
1
mws mclickhouse cluster list
```
Узнайте имя шарда, в котором находятся узлы:
bash
```
1
mws mclickhouse shard list --cluster <имя кластера>
```

Измените конфигурацию:

1
mws mclickhouse cluster update <имя кластера> --shards '
2
  name: <имя шарда>
3
  resources:
4
    vmType: <тип ВМ — CPU и RAM нельзя уменьшить после создания кластера>
5
    disk:
6
      size: <размер диска в гигабайтах — его нельзя уменьшить после создания кластера>
7
'

Если конфигурация была изменена успешно, в ответе будут выведены обновленные параметры кластера.

Убедитесь, что у вас есть IAM-токен для авторизации запроса. Если нет, получите его.

Узнайте имя кластера:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters \
2
  -H "Authorization: Bearer <IAM-токен>"

Узнайте имя шарда, в котором находятся узлы:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>"

Измените конфигурацию:

1
curl -X POST https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>" \
3
  -H "Content-Type: application/json" \
4
  -d '{
5
        "spec": {
6
          "shards": [
7
            {
8
              "name": "<имя шарда>",
9
              "resources": {
10
                "vmType": "<тип ВМ — CPU и RAM нельзя уменьшить после создания кластера>",
11
                "disk": {
12
                  "size": "<размер диска в гигабайтах — его нельзя уменьшить после создания кластера>"
13
                }
14
              }
15
            }
16
          ]
17
        }
18
      }'

Если конфигурация была изменена успешно, вы получите ответ с кодом 200 OK и обновленными параметрами кластера.

Изменить конфигурацию узлов ClickHouse Keeper

Веб-консоль
MWS CLI
API

В веб-консоли выберите нужный проект.
В списке сервисов выберите Managed ClickHouse.
Нажмите на имя нужного кластера.
Нажмите на значок редактирования для блока Конфигурация ClickHouse Keeper и измените конфигурацию.
Нажмите кнопку Сохранить.

Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.
Узнайте имя кластера:
bash
```
1
mws mclickhouse cluster list
```

Измените конфигурацию:

1
mws mclickhouse cluster update <имя кластера> --body '
2
spec:
3
  coordinator:
4
    resources:
5
      vmType: <тип ВМ — CPU и RAM нельзя уменьшить после создания кластера>
6
      disk:
7
        size: <размер диска в гигабайтах — его нельзя уменьшить после создания кластера>
8
    instances:
9
      - count: 1
10
        zone: ru-central1-a
11
      - count: 2
12
        zone: ru-central1-b
13
'

Если конфигурация была изменена успешно, в ответе будут выведены обновленные параметры кластера.

Убедитесь, что у вас есть IAM-токен для авторизации запроса. Если нет, получите его.

Узнайте имя кластера:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters \
2
  -H "Authorization: Bearer <IAM-токен>"

Измените конфигурацию:

1
curl -X POST https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>" \
3
  -H "Content-Type: application/json" \
4
  -d '{
5
        "spec": {
6
          "coordinator": {
7
            "resources": {
8
              "vmType": "<тип ВМ — CPU и RAM нельзя уменьшить после создания кластера>",
9
              "disk": {
10
                "size": "<размер диска в гигабайтах — его нельзя уменьшить после создания кластера>"
11
              }
12
            },
13
            "instances": [
14
              {
15
                "count": 1,
16
                "zone": "ru-central1-a"
17
              },
18
              {
19
                "count": 2,
20
                "zone": "ru-central1-b"
21
              }
22
            ]
23
          }
24
        }
25
      }'

Если конфигурация была изменена успешно, вы получите ответ с кодом 200 OK и обновленными параметрами кластера.

Изменить настройки ClickHouse

Веб-консоль
MWS CLI
API

В веб-консоли выберите нужный проект.
В списке сервисов выберите Managed ClickHouse.
Нажмите на имя нужного кластера и перейдите на вкладку Настройки.
Измените расширенные настройки ClickHouse.

Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.
Узнайте имя кластера:
bash
```
1
mws mclickhouse cluster list
```
Измените настройки.

Внимание
Перечислите в команде все параметры, для которых ранее были заданы значения. Неупомянутые в команде параметры вернутся к значениям по умолчанию.
bash
```
1
mws mclickhouse cluster update <имя кластера> \
2
  --config '{"<параметр>": <значение>, "<группа параметров>": {"<параметр>": <значение>, "<параметр>": <значение>}}'
```
Если команда была выполнена успешно, в ответе будут выведены обновленные параметры кластера.

Убедитесь, что у вас есть IAM-токен для авторизации запроса. Если нет, получите его.

Узнайте имя кластера:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters \
2
  -H "Authorization: Bearer <IAM-токен>"

Измените настройки.

1
curl -X POST https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>" \
3
  -H "Content-Type: application/json" \
4
  -d '{
5
        "spec": {
6
          "config": {
7
            "<параметр>": <значение>,
8
            "<группа параметров>": {
9
              "<параметр>": <значение>,
10
              "<параметр>": <значение>
11
            },
12
          }
13
        }
14
      }'

Если запрос был принят успешно, вы получите ответ с кодом 200 OK и обновленными параметрами кластера.

Изменить настройки сервисного окна

Веб-консоль
MWS CLI
API

В веб-консоли выберите нужный проект.
В списке сервисов выберите Managed ClickHouse.
Нажмите на имя нужного кластера и перейдите на вкладку Настройки.
Измените день и время, когда начинается сервисное окно.

Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.
Узнайте имя кластера:
bash
```
1
mws mclickhouse cluster list
```

Измените настройки:

1
mws mclickhouse cluster update <имя кластера> \
2
  --maintenance-window-weekly-days <день для сервисного окна — например, MONDAY> \
3
  --maintenance-window-weekly-hour <время начала сервисного окна — от 0 до 23>

Если команда была выполнена успешно, в ответе будут выведены обновленные параметры кластера.

Убедитесь, что у вас есть IAM-токен для авторизации запроса. Если нет, получите его.

Узнайте имя кластера:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters \
2
  -H "Authorization: Bearer <IAM-токен>"

Измените настройки:

1
curl -X POST https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>" \
3
  -H "Content-Type: application/json" \
4
  -d '{
5
        "spec": {
6
          "maintenanceWindow": {
7
            "weekly": {
8
              "days": [
9
                "<день для сервисного окна — например, MONDAY>"
10
              ],
11
              "hour": "<время начала сервисного окна — от 0 до 23>"
12
            }
13
          }
14
        }
15
      }'

Если запрос был принят успешно, вы получите ответ с кодом 200 OK и обновленными параметрами кластера.

Остановить кластер

Веб-консоль
MWS CLI
API

В веб-консоли выберите нужный проект.
В списке сервисов выберите Managed ClickHouse.
Нажмите на значок ... для нужного кластера и выберите Остановить.
Подтвердите остановку.

Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.
Узнайте имя кластера:
bash
```
1
mws mclickhouse cluster list
```
Остановите кластер:
bash
```
1
mws mclickhouse cluster stop <имя кластера>
```
Если кластер был остановлен успешно, в ответе будут выведены обновленные параметры кластера.

Убедитесь, что у вас есть IAM-токен для авторизации запроса. Если нет, получите его.

Узнайте имя кластера:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters \
2
  -H "Authorization: Bearer <IAM-токен>"

Остановите кластер:
bash
```
1
curl -X POST https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера>:stop \
2
  -H "Authorization: Bearer <IAM-токен>"
```
Если кластер был остановлен успешно, вы получите ответ с кодом 200 OK и обновленными параметрами кластера.

Запустить кластер

Веб-консоль
MWS CLI
API

В веб-консоли выберите нужный проект.
В списке сервисов выберите Managed ClickHouse.
Нажмите на значок ... для нужного кластера и выберите Запустить.
Подтвердите запуск.

Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.
Узнайте имя кластера:
bash
```
1
mws mclickhouse cluster list
```
Запустите кластер:
bash
```
1
mws mclickhouse cluster start <имя кластера>
```
Если кластер был запущен успешно, в ответе будут выведены обновленные параметры кластера.

Убедитесь, что у вас есть IAM-токен для авторизации запроса. Если нет, получите его.

Узнайте имя кластера:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters \
2
  -H "Authorization: Bearer <IAM-токен>"

Запустите кластер:
bash
```
1
curl -X POST https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера>:start \
2
  -H "Authorization: Bearer <IAM-токен>"
```
Если кластер был запущен успешно, вы получите ответ с кодом 200 OK и обновленными параметрами кластера.

Удалить кластер

Веб-консоль
MWS CLI
API

В веб-консоли выберите нужный проект.
В списке сервисов выберите Managed ClickHouse.
Нажмите на значок ... для удаляемого кластера и выберите Удалить.
Подтвердите удаление.

Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.
Узнайте имя кластера:
bash
```
1
mws mclickhouse cluster list
```
Удалите кластер:
bash
```
1
mws mclickhouse cluster delete <имя кластера>
```
В случае успешного удаления на экран будет выведен ответ success.

Убедитесь, что у вас есть IAM-токен для авторизации запроса. Если нет, получите его.

Узнайте имя кластера:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters \
2
  -H "Authorization: Bearer <IAM-токен>"

Удалите кластер:

1
curl -X DELETE https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>"