DescribeDBClusterConfig - ApsaraDB for SelectDB - Alibaba Cloud Documentation Center

Queries the configuration information about a cluster in an ApsaraDB for SelectDB instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

selectdb:DescribeDBClusterConfig

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ConfigKey	string	Yes	The configuration file to be modified. For a compute cluster, set the value to be.conf. For a frontend (FE) cluster, set the value to fe.conf. Valid values: fe.conf : fe.conf be.conf : be.conf	be.conf
DBClusterId	string	Yes	The cluster ID.	selectdb-cn-7213c8yvv09-be
DBInstanceId	string	Yes	The instance ID.	selectdb-cn-7213cjv****
RegionId	string	No	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response parameters.
Data	object	The information returned.
DbInstanceName	string	The instance ID.	selectdb-cn-wny3li0****
DbInstanceId	string	The numeric ID of the instance.	6585
DbClusterId	string	The cluster ID.	selectdb-cn-wny3li0****-be
TaskId	integer	The task ID.	107841167
Params	array<object>	The details about each parameter returned.
	object
Name	string	The name of the parameter.	doris_scanner_thread_pool_thread_num
Optional	string	The value range of the parameter.	[0-20000]
Comment	string	The comments on the parameter.	存储引擎并发扫描硬盘的线程数。采用线程池统一管理。
Value	string	The current value of the parameter.	10
ParamCategory	string	The category of the parameter.	查询
DefaultValue	string	The default value of the parameter.	15
IsDynamic	integer	Indicates whether the parameter immediately takes effect without requiring a restart.	true
IsUserModifiable	integer	Indicates whether the parameter is modifiable.	true
DynamicCode	string	The dynamic code. This parameter is not returned.	0
DynamicMessage	string	The dynamic message. This parameter is not returned.	An error occurred while processing your request.
AccessDeniedDetail	string	The details about the access denial. This parameter is returned only if Resource Access Management (RAM) authentication failed.	failed
RequestId	string	The request ID.	ADF42B18-43FD-5100-83A9-BE81AB70C863

Examples

Success response

JSON format

{
  "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"
}

Error codes

HTTP status code	Error code	Error message	Description
400	DocumentConvertFailed.ExceedFileSizeLimit	The conversion has been failed, exceed file size limit.	english description1
400	Forbidden	User not authorized to operate on the specified resource, or this API does not support RAM.	english description1
400	InvalidDBName	The specified database name is not allowed.	english description1
400	CreateOrderFailed	Failed to create order.	Failed to create order.
400	InvalidDBInstanceId.Malformed	The specified parameter "DBInstanceId" is not valid.	The parameter "DBInstanceId" is illegal.
403	DBClusterNotSupported	The requested operation can not be performed while the cluster is not sale.	The requested operation cannot be performed while the cluster is not running.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	english description1
403	InstanceEngineType.NotSupport	The instance engine and type does not support operations.	english description1
403	InvalidDBInstanceState.NotSupport	The specified instance state does't support this operation.	The instance is in a state that does not support the current operation.
403	MoneyLessThan100	The Account Monet less Than 100.	english description1
403	OperationDenied.DBNameAndAccountPrivilegeCount	The operation is not permitted due to count of database or account privilege.	english description1
403	InsufficientResourceCapacity	The resource is out of usage.	Not enough resources, please try again later.
404	DBInstanceLocked	The current instance lock mode does not support this operation.	english description1
404	IncorrectVswitchId	The specified parameter VSwitchId is not valid.	english description1
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	InvalidDBInstance.NotFound	The specified instance is not found.	english description1
404	InvalidDBInstanceClass.NotFound	The specified instance classic does not exist.	english description1
404	InvalidRegionId.NotFound	The provided RegionId does not exist in our records.	english description1
404	QueryPrice.Failed	The inquiry failed. Contact Alibaba Cloud customer service representatives.	english description1
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.	Instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.