DescribeDBClusterConfig - 查看集群配置 - 云数据库 SelectDB 版

查看集群配置。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ConfigKey	string	是	修改的配置项文件。计算集群为：be.conf。 fe 集群为：fe.conf。	be.conf
DBClusterId	string	是	集群 ID。	selectdb-cn-7213c8yvv09-be
DBInstanceId	string	是	实例 ID。	selectdb-cn-7213cjv****
RegionId	string	否	地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	PlainResponse
Data	object	返回数据。
DbInstanceName	string	实例 ID。	selectdb-cn-wny3li0****
DbInstanceId	string	实例数字 ID。	6585
DbClusterId	string	集群 ID。	selectdb-cn-wny3li0****-be
TaskId	integer	任务 ID。	107841167
Params	array<object>	用户参数。
Param	object	用户参数。
Name	string	配置项名称。	doris_scanner_thread_pool_thread_num
Optional	string	取值范围。	[0-20000]
Comment	string	字段的注释。	存储引擎并发扫描硬盘的线程数。采用线程池统一管理。
Value	string	当前值。	10
ParamCategory	string	配置项归类。	查询
DefaultValue	string	参数默认值。	15
IsDynamic	integer	是否动态生效（不需要重启）。	true
IsUserModifiable	integer	是否允许用户修改。	true
DynamicCode	string	动态 code，暂无使用，请忽略。	0
DynamicMessage	string	动态消息，暂无使用，请忽略。	An error occurred while processing your request.
AccessDeniedDetail	string	访问被拒绝详细信息；只有校验 RAM 失败后，字段才会返回。	failed
RequestId	string	请求 ID。	ADF42B18-43FD-5100-83A9-BE81AB70C863

示例

正常返回示例

JSON格式

{
  "Data": {
    "DbInstanceName": "selectdb-cn-wny3li0****",
    "DbInstanceId": "6585",
    "DbClusterId": "selectdb-cn-wny3li0****-be",
    "TaskId": 107841167,
    "Params": [
      {
        "Name": "doris_scanner_thread_pool_thread_num",
        "Optional": "[0-20000]",
        "Comment": "存储引擎并发扫描硬盘的线程数。采用线程池统一管理。",
        "Value": "10",
        "ParamCategory": "查询",
        "DefaultValue": "15",
        "IsDynamic": 0,
        "IsUserModifiable": 0
      }
    ]
  },
  "DynamicCode": "0",
  "DynamicMessage": "An error occurred while processing your request.",
  "AccessDeniedDetail": "failed",
  "RequestId": "ADF42B18-43FD-5100-83A9-BE81AB70C863"
}

错误码

HTTP status code	错误码	错误信息	描述
400	DocumentConvertFailed.ExceedFileSizeLimit	The conversion has been failed, exceed file size limit.	文档转换失败，文件大小超过系统限额。
400	Forbidden	User not authorized to operate on the specified resource, or this API does not support RAM.	子账号权限不足，请先获取授权。
400	InvalidDBName	The specified database name is not allowed.	数据库名称不符合要求，请确认数据名称是否正确。
400	CreateOrderFailed	Failed to create order.	创建订单失败。
403	DBClusterNotSupported	The requested operation can not be performed while the cluster is not sale.	当集群未运行时，无法执行请求的操作。
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	当前实例状态不支持此操作。
403	InstanceEngineType.NotSupport	The instance engine and type does not support operations.	操作失败，实例引擎和类型不支持该操作。
403	InvalidDBInstanceState.NotSupport	The specified instance state does't support this operation.	指定的实例状态不支持此操作。
403	MoneyLessThan100	The Account Monet less Than 100.	当前阿里云账号余额不足100，请充值。
403	OperationDenied.DBNameAndAccountPrivilegeCount	The operation is not permitted due to count of database or account privilege.	操作失败，数据库与权限的数量不一致。
403	InsufficientResourceCapacity	The resource is out of usage.	资源不足，请您稍后再试。
404	DBInstanceLocked	The current instance lock mode does not support this operation.	操作失败，当前实例已锁定。
404	IncorrectVswitchId	The specified parameter VSwitchId is not valid.	交换机参数无效。
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.	找不到指定的 API。请检查调用的 URL 和方法。您调用的 API 不存在。请检查 API 的名称是否正确，请注意确认大小写。
404	InvalidDBInstance.NotFound	The specified instance is not found.	没有找到指定的实例，请检查实例的正确性。
404	InvalidDBInstanceClass.NotFound	The specified instance classic does not exist.	当前选择的配置或规格不存在或已停售，请重新选择。
404	InvalidRegionId.NotFound	The provided RegionId does not exist in our records.	操作失败，输入的地域及可用区不存在。
404	QueryPrice.Failed	The inquiry failed. Contact Alibaba Cloud customer service representatives.	询价失败，请联系客服同学。

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

变更历史

变更时间	变更内容概要	操作
2024-04-09	OpenAPI 入参发生变更	查看变更详情