DescribeDBClusterConfig - 查看集群参数配置信息 - 云数据库 ClickHouse

调用DescribeDBClusterConfig接口查询社区兼容版集群的参数配置信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
clickhouse:DescribeDBClusterConfig	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
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.	系统暂时不可用，请稍后重试

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

变更历史

变更时间	变更内容概要	操作
2024-09-25	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情