DescribeDBClusterConfig - 查看集群配置

查看集群配置。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
ConfigKeystring

修改的配置项文件。

  • 计算集群为:be.conf。
  • fe 集群为:fe.conf。
be.conf
DBClusterIdstring

集群 ID。

selectdb-cn-7213c8yvv09-be
DBInstanceIdstring

实例 ID。

selectdb-cn-7213cjv****
RegionIdstring

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

PlainResponse

Dataobject

返回数据。

DbInstanceNamestring

实例 ID。

selectdb-cn-wny3li0****
DbInstanceIdstring

实例数字 ID。

6585
DbClusterIdstring

集群 ID。

selectdb-cn-wny3li0****-be
TaskIdinteger

任务 ID。

107841167
Paramsarray<object>

用户参数。

Paramobject

用户参数。

Namestring

配置项名称。

doris_scanner_thread_pool_thread_num
Optionalstring

取值范围。

[0-20000]
Commentstring

字段的注释。

存储引擎并发扫描硬盘的线程数。采用线程池统一管理。
Valuestring

当前值。

10
ParamCategorystring

配置项归类。

查询
DefaultValuestring

参数默认值。

15
IsDynamicinteger

是否动态生效(不需要重启)。

true
IsUserModifiableinteger

是否允许用户修改。

true
DynamicCodestring

动态 code,暂无使用,请忽略。

0
DynamicMessagestring

动态消息,暂无使用,请忽略。

An error occurred while processing your request.
AccessDeniedDetailstring

访问被拒绝详细信息;只有校验 RAM 失败后,字段才会返回。

failed
RequestIdstring

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

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

变更历史

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