All Products
Search
Document Center

ApsaraDB for SelectDB:DescribeDBClusterConfig

Last Updated:Dec 18, 2024

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
selectdb:DescribeDBClusterConfigget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ConfigKeystringYes

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.
be.conf
DBClusterIdstringYes

The cluster ID.

selectdb-cn-7213c8yvv09-be
DBInstanceIdstringYes

The instance ID.

selectdb-cn-7213cjv****
RegionIdstringNo

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Dataobject

The information returned.

DbInstanceNamestring

The instance ID.

selectdb-cn-wny3li00g02
DbInstanceIdstring

The numeric ID of the instance.

6585
DbClusterIdstring

The cluster ID.

selectdb-cn-wny3li00g02-be
TaskIdinteger

The task ID.

107841167
Paramsarray<object>

The details about each parameter returned.

Paramobject
Namestring

The name of the parameter.

doris_scanner_thread_pool_thread_num
Optionalstring

The value range of the parameter.

[0-20000]
Commentstring

The comments on the parameter.

Valuestring

The current value of the parameter.

10
ParamCategorystring

The category of the parameter.

DefaultValuestring

The default value of the parameter.

15
IsDynamicinteger

Indicates whether the parameter immediately takes effect without requiring a restart.

true
IsUserModifiableinteger

Indicates whether the parameter is modifiable.

true
DynamicCodestring

The dynamic code. This parameter is not returned.

0
DynamicMessagestring

The dynamic message. This parameter is not returned.

An error occurred while processing your request.
AccessDeniedDetailstring

The details about the access denial. This parameter is returned only if Resource Access Management (RAM) authentication failed.

failed
RequestIdstring

The request ID.

ADF42B18-43FD-5100-83A9-BE81AB70C863

Examples

Sample success responses

JSONformat

{
  "Data": {
    "DbInstanceName": "selectdb-cn-wny3li00g02",
    "DbInstanceId": "6585",
    "DbClusterId": "selectdb-cn-wny3li00g02-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 codeError codeError messageDescription
400DocumentConvertFailed.ExceedFileSizeLimitThe conversion has been failed, exceed file size limit.english description1
400ForbiddenUser not authorized to operate on the specified resource, or this API does not support RAM.english description1
400InvalidDBNameThe specified database name is not allowed.english description1
400CreateOrderFailedFailed to create order.Failed to create order.
403DBClusterNotSupportedThe requested operation can not be performed while the cluster is not sale.The requested operation cannot be performed while the cluster is not running.
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.english description1
403InstanceEngineType.NotSupportThe instance engine and type does not support operations.english description1
403InvalidDBInstanceState.NotSupportThe specified instance state does't support this operation.The instance is in a state that does not support the current operation.
403MoneyLessThan100The Account Monet less Than 100.english description1
403OperationDenied.DBNameAndAccountPrivilegeCountThe operation is not permitted due to count of database or account privilege.english description1
403InsufficientResourceCapacityThe resource is out of usage.Not enough resources, please try again later.
404DBInstanceLockedThe current instance lock mode does not support this operation.english description1
404IncorrectVswitchIdThe specified parameter VSwitchId is not valid.english description1
404InvalidApi.NotFoundSpecified api is not found, please check your url and method.-
404InvalidDBInstance.NotFoundThe specified instance is not found.english description1
404InvalidDBInstanceClass.NotFoundThe specified instance classic does not exist.english description1
404InvalidRegionId.NotFoundThe provided RegionId does not exist in our records.english description1
404QueryPrice.FailedThe inquiry failed. Contact Alibaba Cloud customer service representatives.english description1

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-04-09The request parameters of the API has changedView Change Details