DescribeDBInstanceConfig-阿里云帮助中心

Queries the parameter configuration of an 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

clickhouse:DescribeDBInstanceConfig

get

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	cc-wz9go4x*****
RegionId	string	Yes	The region ID.	cn-hangzhou

Response elements

Parameter	Type	Description	Example
	object	The response schema
RequestId	string	The ID of the request	66428721-xxxx-xxxx-xxxx-3BD1B67837E0
Data	object	The returned results.
DBInstanceId	string	The instance ID.	cc-bp100p4q1g9z3****
Params	array	The user parameters.
	object	The user parameters.
IsDynamic	integer	Indicates whether the parameter takes effect dynamically (without requiring a restart).	1
IsUserModifiable	integer	Indicates whether the parameter can be modified by users.	1
DefaultValue	string	The default value of the parameter.	1
Name	string	The parameter name.	max_concurrent_queries
Optional	string	The valid values of the parameter.	[0-100]
Comment	string	The parameter description.	Maximum number of concurrently executed queries. Zero means unlimited.
ParamRelyRule	string	The parameter dependencies.	0
Value	string	The value of the parameter.	100

Examples

Success response

JSON format

{
  "RequestId": "66428721-xxxx-xxxx-xxxx-3BD1B67837E0\n",
  "Data": {
    "DBInstanceId": "cc-bp100p4q1g9z3****",
    "Params": [
      {
        "IsDynamic": 1,
        "IsUserModifiable": 1,
        "DefaultValue": "1",
        "Name": "max_concurrent_queries",
        "Optional": "[0-100]",
        "Comment": "Maximum number of concurrently executed queries. Zero means unlimited.",
        "ParamRelyRule": "0",
        "Value": "100"
      }
    ]
  }
}

Error codes

See for a complete list.

Release notes

See Release Notes for a complete list.