调用DescribeDBClusterConfig接口查询社区兼容版集群的参数配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
clickhouse:DescribeDBClusterConfig |
get |
*DBCluster
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
否 |
地域 ID。您可以通过调用 DescribeRegions 接口查询地域 ID。 |
cn-hangzhou |
DBClusterId |
string |
是 |
集群 ID。 |
cc-wz988vja2mor4**** |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
RequestId |
string |
请求 ID。 |
9A23C87D-87DF-4DA0-A50E-CB13F4F7923D |
Config |
string |
集群的参数配置信息。 |
[ { "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." } ] |
示例
正常返回示例
JSON
格式
{
"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.\" } ]"
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
500 | InternalError | An error occurred while processing your request. | 系统内部错误,请稍后重试 |
503 | ServiceUnavailable | An error occurred while processing your request. | 系统暂时不可用,请稍后重试 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。