DescribeDBClusterConfig - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries information about the parameter settings of an ApsaraDB for ClickHouse cluster.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
clickhouse:DescribeDBClusterConfig	get	DBCluster acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBClusterId	string	Yes	The cluster ID.	cc-wz988vja2mor4****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	9A23C87D-87DF-4DA0-A50E-CB13F4F7923D
Config	string	The information about the parameter settings of the cluster.	[ { "name": "keep_alive_timeout", "defaultValue": 300, "currentValue": 300, "restart": true, "valueRange": ">0", "desc": "The number of seconds that ClickHouse waits for incoming requests before closing the connection." }, ... ,{ "name": "max_partition_size_to_drop", "defaultValue": 0, "currentValue": 0, "restart": true, "valueRange": ">=0", "desc": "If the size of a MergeTree partition exceeds max_partition_size_to_drop (in bytes), you can’t delete it using a DROP query." } ]

Examples

Sample success responses

JSONformat

{
  "RequestId": "9A23C87D-87DF-4DA0-A50E-CB13F4F7923D",
  "Config": "[ { \"name\": \"keep_alive_timeout\", \"defaultValue\": 300, \"currentValue\": 300, \"restart\": true, \"valueRange\": \">0\", \"desc\": \"The number of seconds that ClickHouse waits for incoming requests before closing the connection.\" }, ... ,{ \"name\": \"max_partition_size_to_drop\", \"defaultValue\": 0, \"currentValue\": 0, \"restart\": true, \"valueRange\": \">=0\", \"desc\": \"If the size of a MergeTree partition exceeds max_partition_size_to_drop (in bytes), you can’t delete it using a DROP query.\" } ]"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.	An error occurred while processing your request.

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

Change history

Change time	Summary of changes	Operation
2024-09-25	API Description Update. The Error code has changed	View Change Details