All Products
Search
Document Center

ApsaraDB for ClickHouse:DescribeDBClusterConfigInXML

Last Updated:Nov 12, 2024

Queries the values of the configuration parameters in the config.xml file of an ApsaraDB for ClickHouse cluster.

Operation description

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
clickhouse:DescribeDBClusterConfigInXMLget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
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-bp108z124a8o7****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

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

The values of the configuration parameters.

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

Examples

Sample success responses

JSONformat

{
  "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 Service error codes.

Change history

Change timeSummary of changesOperation
2024-09-26API Description UpdateView Change Details
2022-09-22Add OperationView Change Details