Use DescribeDBClusterConfigInXML to query cluster configuration parameters in XML format - ApsaraDB for ClickHouse

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	describeDBClusterConfigInXML	The operation that you want to perform. Set the value to describeDBClusterConfigInXML.
RegionId	String	No	cn-hangzhou	The ID of the region. You can call the DescribeRegions operation to query the most recent region list.
DBClusterId	String	Yes	cc-bp108z124a8o7****	The ID of the cluster. You can call the DescribeDBClusters operation to query information about all the clusters that are deployed in a specific region. The returned information includes the ID of each cluster.

Response parameters


Parameter	Type	Example	Description
RequestId	String	FE042911-2B00-134C-9F42-816871BBAFB8	The ID of the request.
Config	String	<?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>	The configuration parameters.

Examples

Sample requests

http(s)://clickhouse.aliyuncs.com/?Action=describeDBClusterConfigInXML
&RegionId=cn-hangzhou
&DBClusterId=cc-bp108z124a8o7****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/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>"
}

Error codes

For a list of error codes, visit the API Error Center.