ClickHouse® cluster maintenance

Written by

Updated at March 31, 2026

Getting a list of maintenance jobs
Getting maintenance-related cluster logs
Postpone the planned maintenance
Starting scheduled maintenance immediately
Configuring a maintenance window

You can manage maintenance of a Yandex Managed Service for ClickHouse® cluster.

Getting a list of maintenance jobs

Go to Managed Service for ClickHouse.
Click the name of your cluster and select the Maintenance tab.

To view maintenance jobs with a specific status, click Status above the maintenance list and select the status you want from the drop-down menu. You can also find a maintenance job by its ID or job name using the search field above the list.

Click an ID to see how the maintenance job affects cluster availability. Look up Task details to see how the maintenance job affects users.

Getting maintenance-related cluster logs

Navigate to the Managed Service for ClickHouse service.
Click the name of your cluster and select the Maintenance tab.
Click the ID of the maintenance job you need.
Click Task logs.

Postpone the planned maintenance

Maintenance jobs with the Planned status have a specific scheduled date and time specified in the Start date column. You can reschedule them to a new date and time if needed.

Management console

CLI

REST API

gRPC API

To reschedule maintenance for a new date and time:

Navigate to the Managed Service for ClickHouse service.
Click the name of your cluster and select the Maintenance tab.
Click next to the maintenance job with the Planned status.
In the drop-down menu, select Postpone.
In the window that opens:
- To postpone the maintenance until the next available window, click Next window and then Reschedule.
- To reschedule maintenance to a specific UTC date and time, click Choose date (UTC), then select a new date and time interval and click Reschedule.

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

The folder used by default is the one specified when creating the CLI 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 options.

To reschedule maintenance for a new date and time:

See the description of the CLI command for rescheduling maintenance :
```
yc managed-clickhouse cluster reschedule-maintenance --help
```
To reschedule to the next available window, run this command using the next-available-window reschedule type. To reschedule to a specific date and time, use the specific-time reschedule type:
```
yc managed-clickhouse cluster reschedule-maintenance <cluster_name_or_ID> \
   --reschedule-type <reschedule_type> \
   --delayed-until <timestamp>
```
The timestamp must be in one of the following formats:
- RFC-3339
- HH:MM:SS
- Maintenance time offset in hours and minutes.
For example, 2006-01-02T15:04:05Z, 15:04:05, 2h, or 3h30m ago. With the next-available-window reschedule type, you do not need to specify --delayed-until.

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

To reschedule maintenance for a new date and time:

Get an IAM token for API authentication and put it into an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Call the Cluster.RescheduleMaintenance method, e.g., via the following cURL request:
```
curl \
--request POST \
--header "Authorization: Bearer $IAM_TOKEN" \
--header "Content-Type: application/json" \
--url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<cluster_ID>:rescheduleMaintenance' \
--data '{
            "rescheduleType": <reschedule_type>,
            "delayedUntil": <timestamp>
        }'
```
Where rescheduleType is the reschedule type that can be one of the following values:
- NEXT_AVAILABLE_WINDOW: Postpone maintenance until the next available window.
- SPECIFIC_TIME: Move the maintenance to a specific date and time.
The timestamp must be in RFC-3339 format, e.g., 2006-01-02T15:04:05Z. When selecting the NEXT_AVAILABLE_WINDOW reschedule type, you do not need to specify delayedUntil.

You can get the cluster ID from the folder’s cluster list.
Check the server response to make sure your request was successful.

Get an IAM token for API authentication and put it into an 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 that the repository contents reside in the ~/cloudapi/ directory.
Call the ClusterService.RescheduleMaintenance 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/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "cluster_id": "<cluster_ID>",
        "reschedule_type": <reschedule_type>,
        "delayed_until": <timestamp>
      }' \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.clickhouse.v1.ClusterService.RescheduleMaintenance
```
Where reschedule_type is the reschedule type that can be one of the following values:
- NEXT_AVAILABLE_WINDOW: Move the maintenance to the nearest window.
- SPECIFIC_TIME: Move the maintenance to a specific date and time.
The timestamp must be in RFC-3339 format, e.g., 2006-01-02T15:04:05Z. When selecting the NEXT_AVAILABLE_WINDOW reschedule type, you do not need to specify delayed_until.

You can request the cluster ID with the list of clusters in the folder.
Check the server response to make sure your request was successful.

Starting scheduled maintenance immediately

If necessary, you can run a maintenance job with the Planned status immediately, prior to the time specified in the Start date column.

Management console

CLI

REST API

gRPC API

To run a scheduled cluster maintenance job immediately:

Navigate to the Managed Service for ClickHouse service.
Click the name of your cluster and select the Maintenance tab.
Click next to the maintenance job you need.
In the drop-down menu, select Carry out now.

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

To run a scheduled cluster maintenance job immediately:

See the description of the CLI command for rescheduling maintenance :
```
yc managed-clickhouse cluster reschedule-maintenance --help
```
Run this command using the immediate reschedule type:
```
yc managed-clickhouse cluster reschedule-maintenance <cluster_name_or_ID> \
   --reschedule-type immediate
```
You can get the cluster name and ID with the list of clusters in the folder.

To run a scheduled cluster maintenance job immediately:

Get an IAM token for API authentication and put it into an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```

Call the Cluster.RescheduleMaintenance method, e.g., via the following cURL request:

curl \
--request POST \
--header "Authorization: Bearer $IAM_TOKEN" \
--header "Content-Type: application/json" \
--url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<cluster_ID>:rescheduleMaintenance' \
--data '{
            "rescheduleType": "IMMEDIATE"
        }'

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

Check the server response to make sure your request was successful.

Get an IAM token for API authentication and put it into an 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 that the repository contents reside in the ~/cloudapi/ directory.

Call the ClusterService.RescheduleMaintenance 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/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "cluster_id": "<cluster_ID>",
        "reschedule_type": "IMMEDIATE"
      }' \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.clickhouse.v1.ClusterService.RescheduleMaintenance

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

Check the server response to make sure your request was successful.

Configuring a maintenance window

By default, maintenance can be scheduled for any time. You can choose a specific day of the week and hour to schedule maintenance. For example, you can choose the time when the cluster is least busy.

Warning

If a scheduled maintenance does not fall within the new interval, it will be automatically canceled.

Management console

CLI

Terraform

REST API

gRPC API

Navigate to the Managed Service for ClickHouse service.
Click the name of your cluster and select the Maintenance tab.
Click Configure the maintenance window.
In the window that opens:
- To allow maintenance at any time, select arbitrary, which is also the default option.
- To allow weekly maintenance at a specific time, select by schedule and specify the weekday and hour in UTC.

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

See the description of the CLI command for updating the maintenance window:
```
yc managed-clickhouse cluster update --help
```
Run this command:
```
yc managed-clickhouse cluster update <cluster_name_or_ID> \
   --maintenance-window type=<maintenance_type>,`
                       `day=<day_of_week>,`
                       `hour=<hour>
```
Where type is the maintenance type:
- anytime: At any time (default).
- weekly: On a schedule. For this value, also specify the following:
  - day: Day of week, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.
  - hour: Hour of day (UTC), from 1 to 24.
You can get the cluster name and ID with the list of clusters in the folder.

Open the current Terraform configuration file describing your infrastructure.

For more on how to create this file, see Creating a cluster.

For a complete list of configurable Managed Service for ClickHouse® cluster fields, see this Terraform provider guide.
To set up the maintenance window that will also apply to stopped clusters, add the maintenance_window section to the cluster description:
```
resource "yandex_mdb_clickhouse_cluster" "<cluster_name>" {
  ...
  maintenance_window {
    type = "<maintenance_type>"
    day  = "<day_of_week>"
    hour = <hour>
  }
  ...
}
```
Where:
- type: Maintenance type. The possible values include:
  - ANYTIME: Anytime
  - WEEKLY: On a schedule
- day: Day of week for the WEEKLY type, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.
- hour: UTC hour for the WEEKLY type, from 1 to 24.
Validate your configuration.
1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.
2. Run this command:
```
terraform validate
```
  Terraform will show any errors found in your configuration files.
Confirm updating the resources.
1. Run this command to view the planned changes:
```
terraform plan
```
  If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.
2. If everything looks correct, apply the changes:
  1. Run this command:
```
terraform apply
```
  2. Confirm updating the resources.
  3. Wait for the operation to complete.
Timeouts
The Terraform provider sets the following timeouts for Managed Service for ClickHouse® cluster operations:
- Creating a cluster, including by restoring from a backup: 60 minutes.
- Updating a cluster: 90 minutes.
- Deleting a cluster: 30 minutes.
Operations exceeding the timeout are aborted.
How do I change these limits?
Add a timeouts section to the cluster description, e.g.:

resource "yandex_mdb_clickhouse_cluster" "<cluster_name>" { ... timeouts { create = "1h30m" # 1 hour 30 minutes update = "2h" # 2 hours delete = "30m" # 30 minutes } }

Get an IAM token for API authentication and put it into an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Call the Cluster.Update method, e.g., via the following cURL request:

Warning

The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.
```
curl \
  --request PATCH \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --header "Content-Type: application/json" \
  --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<cluster_ID>' \
  --data '{
            "updateMask": "maintenanceWindow",
            "maintenanceWindow": {
              "weeklyMaintenanceWindow": {
                "day": "<day_of_week>",
                "hour": "<hour>"
              }
            }
          }'
```
Where:
- updateMask: Comma-separated string of settings to update.
  
  Here, we provide only one setting.
- maintenanceWindow: Maintenance window settings, including for stopped clusters. In maintenanceWindow, provide one of the two values:
  - anytime: Maintenance can be scheduled for any time.
  - weeklyMaintenanceWindow: Maintenance can only be scheduled for a specific day of week and hour:
    - day: Day of week in DDD format, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.
    - hour: Time of day (UTC) in HH format, from 1 to 24.
You can request the cluster ID with the list of clusters in the folder.
Check the server response to make sure your request was successful.

Get an IAM token for API authentication and put it into an 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 that the repository contents reside in the ~/cloudapi/ directory.
Call the ClusterService.Update method, e.g., via the following gRPCurl request:
Warning
The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.
Format for listing settings
"update_mask": { "paths": [ "<setting_1>", "<setting_2>", ... "<setting_N>" ] }
```
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>",
        "update_mask": {
          "paths": ["maintenance_window"]
        },
        "maintenance_window": {
          "weekly_maintenance_window": {
            "day": "<day_of_week>",
            "hour": "<hour>"
          }
        }
      }' \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.clickhouse.v1.ClusterService.Update
```
Where:
- update_mask: List of settings you want to update as an array of strings (paths[]).
  
  Here, we provide only one setting.
- maintenance_window: Maintenance window settings, including for stopped clusters. In maintenance_window, provide one of the two values:
  - anytime: Maintenance can be scheduled for any time.
  - weekly_maintenance_window: Maintenance can only be scheduled for a specific day of week and hour:
    - day: Day of week in DDD format, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.
    - hour: Time of day (UTC) in HH format, from 1 to 24.
You can request the cluster ID with the list of clusters in the folder.
Check the server response to make sure your request was successful.

ClickHouse® is a registered trademark of ClickHouse, Inc.

ClickHouse® cluster maintenance

Getting a list of maintenance jobsGetting a list of maintenance jobs

Getting maintenance-related cluster logsGetting maintenance-related cluster logs

Postpone the planned maintenancePostpone the planned maintenance

Starting scheduled maintenance immediatelyStarting scheduled maintenance immediately

Configuring a maintenance windowConfiguring a maintenance window

Was the article helpful?

Getting a list of maintenance jobs

Getting maintenance-related cluster logs

Postpone the planned maintenance

Starting scheduled maintenance immediately

Configuring a maintenance window