All Products
Search
Document Center

ApsaraDB for ClickHouse:CheckModifyConfigNeedRestart

Last Updated:Jul 17, 2024

Queries whether an ApsaraDB for ClickHouse cluster needs to be restarted after you change the values of the configuration parameters in XML mode.

Operation description

Note You can call this operation only for ApsaraDB for ClickHouse clusters that were created after December 1, 2021.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID. You can call the DescribeDBClusters operation to query information about all the clusters that are deployed in a specific region. The information includes the cluster IDs.

cc-bp1tm8zf130ew****
ConfigstringYes

The configuration parameters whose settings are modified.

<?xml version="1.0"?> <yandex> <keep_alive_timeout>400</keep_alive_timeout> <listen_backlog>4096</listen_backlog> <logger> <level>debug</level> <size>1000M</size> </logger> <mark_cache_size>5368709120</mark_cache_size> <max_concurrent_queries>201</max_concurrent_queries> <max_connections>4096</max_connections> <max_partition_size_to_drop>0</max_partition_size_to_drop> <max_table_size_to_drop>0</max_table_size_to_drop> <merge_tree> <max_delay_to_insert>256</max_delay_to_insert> <max_part_loading_threads>auto</max_part_loading_threads> <max_suspicious_broken_parts>100</max_suspicious_broken_parts> <zookeeper_session_expiration_check_period>1</zookeeper_session_expiration_check_period> </merge_tree> <uncompressed_cache_size>1717986918</uncompressed_cache_size> </yandex>

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

NeedRestartboolean

Indicates whether the cluster was restarted after you modified the configuration parameters. Valid values:

  • true: The cluster was restarted.
  • false: The cluster was not restarted.
true
RequestIdstring

The request ID.

06798FEE-BEF2-5FAF-A30D-728973BBE97C

Examples

Sample success responses

JSONformat

{
  "NeedRestart": true,
  "RequestId": "06798FEE-BEF2-5FAF-A30D-728973BBE97C"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-09-22Add OperationView Change Details