DescribeDBInstanceConfigChangeLog-阿里云帮助中心

Queries the parameter configuration records 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:DescribeDBInstanceConfigChangeLog

none

*EnterpriseDBCluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	cc-uf6lkzf*****
RegionId	string	Yes	The region ID.	cn-shanghai
StartTime	string	Yes	The start time of the query. Format: yyyy-MM-dd hh:mm:ss.	2025-01-01 10:00:00
EndTime	string	Yes	The end time of the query. Format: yyyy-MM-dd hh:mm:ss.	2025-01-01 10:00:00
PageSize	integer	No	The number of entries to return per page. Default value: 30. Valid values: 30 (default) 50 100	30
PageNumber	integer	No	The page number to return.	1

Response elements

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	780DE414-*********-88BE-A2E21B862B57
Data	object	The result set.
DBInstanceId	string	The instance ID.	cc-bp100p4q1g9z3****
ParamChangeLogs	array	The parameter change records.
	object	The parameter change record.
ID	integer	The operation ID.	1
Name	string	The name of the parameter.	max_concurrent_queries
OldValue	string	The old parameter value.	50
NewValue	string	The new parameter value.	100
Applied	boolean	Indicates whether the configuration takes effect: true: The execution plan takes effect. false: The execution plan does not take effect.
GmtCreated	string	The time when the change was created.	2025-06-25 13:46:06
GmtModified	string	The time when the change was modified.	2025-06-25 13:46:06

Examples

Success response

JSON format

{
  "RequestId": "780DE414-*********-88BE-A2E21B862B57",
  "Data": {
    "DBInstanceId": "cc-bp100p4q1g9z3****",
    "ParamChangeLogs": [
      {
        "ID": 1,
        "Name": "max_concurrent_queries",
        "OldValue": "50",
        "NewValue": "100",
        "Applied": true,
        "GmtCreated": "2025-06-25 13:46:06",
        "GmtModified": "2025-06-25 13:46:06\n"
      }
    ]
  }
}

Error codes

See for a complete list.

Release notes

See Release Notes for a complete list.