DescribeDBClusterConfigInXML - 查询XML模式下的配置参数

调用DescribeDBClusterConfigInXML接口查询云数据库ClickHouse社区兼容版集群XML模式下的配置参数。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

地域 ID。您可以通过调用 DescribeRegions 接口查询地域 ID。

cn-hangzhou
DBClusterIdstring

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

cc-bp108z124a8o7****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

FE042911-2B00-134C-9F42-816871BBAFB8
Configstring

配置参数。

<?xml version="1.0"?> <yandex> <keep_alive_timeout>300</keep_alive_timeout> <listen_backlog>64</listen_backlog> <logger> <level>debug</level> <size>1000M</size> </logger> <mark_cache_size>6871947673</mark_cache_size> <max_concurrent_queries>100</max_concurrent_queries> <max_connections>4096</max_connections> <max_partition_size_to_drop>0</max_partition_size_to_drop> <max_server_memory_usage>0</max_server_memory_usage> <max_server_memory_usage_to_ram_ratio>0.9</max_server_memory_usage_to_ram_ratio> <max_table_size_to_drop>0</max_table_size_to_drop> <max_thread_pool_size>10000</max_thread_pool_size> <merge_tree> <max_delay_to_insert>256</max_delay_to_insert> <max_part_loading_threads>16</max_part_loading_threads> <zookeeper_session_expiration_check_period>1</zookeeper_session_expiration_check_period> </merge_tree> <total_memory_profiler_step>4194304</total_memory_profiler_step> <total_memory_tracker_sample_probability>0</total_memory_tracker_sample_probability> <uncompressed_cache_size>3435973836</uncompressed_cache_size> </yandex>

示例

正常返回示例

JSON格式

{
  "RequestId": "FE042911-2B00-134C-9F42-816871BBAFB8",
  "Config": "<?xml version=\"1.0\"?>\n<yandex>\n    <keep_alive_timeout>300</keep_alive_timeout>\n    <listen_backlog>64</listen_backlog>\n    <logger>\n        <level>debug</level>\n        <size>1000M</size>\n    </logger>\n    <mark_cache_size>6871947673</mark_cache_size>\n    <max_concurrent_queries>100</max_concurrent_queries>\n    <max_connections>4096</max_connections>\n    <max_partition_size_to_drop>0</max_partition_size_to_drop>\n    <max_server_memory_usage>0</max_server_memory_usage>\n<max_server_memory_usage_to_ram_ratio>0.9</max_server_memory_usage_to_ram_ratio>\n    <max_table_size_to_drop>0</max_table_size_to_drop>\n    <max_thread_pool_size>10000</max_thread_pool_size>\n    <merge_tree>\n        <max_delay_to_insert>256</max_delay_to_insert>\n        <max_part_loading_threads>16</max_part_loading_threads>      <zookeeper_session_expiration_check_period>1</zookeeper_session_expiration_check_period>\n    </merge_tree>\n    <total_memory_profiler_step>4194304</total_memory_profiler_step>\n<total_memory_tracker_sample_probability>0</total_memory_tracker_sample_probability>\n    <uncompressed_cache_size>3435973836</uncompressed_cache_size>\n</yandex>"
}

错误码

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

变更历史

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