DescribeDBInstanceConfigChangeLog-阿里云帮助中心

Queries the parameter settings change 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 beginning of the time range to query. Format: yyyy-MM-dd hh:mm:ss.	2025-01-01 10:00:00
EndTime	string	Yes	The end of the time range to query. Format: yyyy-MM-dd hh:mm:ss.	2025-01-01 10:00:00
PageSize	integer	No	The number of entries per page. Valid values: 30 (default) 50 100	30
PageNumber	integer	No	The page number.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	780DE414-*********-88BE-A2E21B862B57
Data	object	The query result set.
DBInstanceId	string	The instance ID.	cc-bp100p4q1g9z3****
ParamChangeLogs	array<object>	The parameter change records.
	object	The parameter change records.
ID	integer	The operation ID.	1
Name	string	The parameter name.	max_concurrent_queries
OldValue	string	The old parameter value.	50
NewValue	string	The new parameter value.	100
Applied	boolean	Indicates whether the configuration has taken effect. Valid values: true: The configuration has taken effect. false: The configuration has not taken effect.
GmtCreated	string	The time when the change was created.	2025-06-25 13:46:06
GmtModified	string	The time when the change was last 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": false,
        "GmtCreated": "2025-06-25 13:46:06",
        "GmtModified": "2025-06-25 13:46:06\n"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.