全部产品
Search
文档中心

云数据库 ClickHouse:CheckModifyConfigNeedRestart - 查询配置参数是否需要重启

更新时间:Dec 05, 2024

调用CheckModifyConfigNeedRestart接口查询云数据库ClickHouse社区兼容版集群在XML模式下配置参数的变更是否需要重启。

接口说明

说明 该接口仅支持 2021 年 12 月 01 日之后创建的社区兼容版集群。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
clickhouse:CheckModifyConfigNeedRestartget
*全部资源
*

请求参数

名称类型必填描述示例值
DBClusterIdstring

集群 ID。您可以通过调用 DescribeDBClusters 接口查询目标地域下所有的集群信息,包括集群 ID。

cc-bp1tm8zf130ew****
Configstring

变更的配置参数。

<?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>

返回参数

名称类型描述示例值
object

Schema of Response

NeedRestartboolean

变更配置参数后是否重启。取值说明:

  • true:重启。
  • false:不重启。
true
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-09-24OpenAPI 描述信息更新查看变更详情
2022-09-22新增 OpenAPI查看变更详情