DescribeConfigHistory - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries the change records of the configuration parameters of an ApsaraDB for ClickHouse cluster.

Operation description

Note You can call this operation only for ApsaraDB for ClickHouse clusters that were created after December 1, 2021.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. You can call the DescribeDBClusters operation to query information about all the clusters that are deployed in a specific region. The information includes the cluster IDs.	cc-bp1p816075e21****
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in Coordinated Universal Time (UTC).	2022-08-11T06:27:00Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2022-08-22T10:06:00Z

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC
ConfigHistoryItems	array<object>	The change records of the configuration parameters.
	object
Time	string	The time when the values of the configuration parameters were changed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-08-22T10:00:00Z
OwnerId	string	The user ID (UID) of the Alibaba Cloud account.	253460731706911258
Reason	string	The reason for the setting modification of the configuration parameters.	test
Success	boolean	Indicates whether the setting modification of the configuration parameters took effect. Valid values: true false	true
ChangeId	string	The ID of the change record.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC",
  "ConfigHistoryItems": [
    {
      "Time": "2022-08-22T10:00:00Z",
      "OwnerId": "253460731706911258",
      "Reason": "test",
      "Success": true,
      "ChangeId": "1"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

Change history

Change time	Summary of changes	Operation
2022-09-22	Add Operation	View Change Details