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

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeConfigHistory

The operation that you want to perform. Set the value to DescribeConfigHistory.

DBClusterId String Yes cc-bp1p816075e21****

The ID of the cluster. You can call the DescribeDBClusters operation to query information about all the clusters that are deployed in a specific region. The returned information includes the ID of each cluster.

StartTime String Yes 2022-08-11T06:27:00Z

The beginning of the time range to query. The value is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

EndTime String Yes 2022-08-22T10:06:00Z

The end of the time range to query. The value is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Response parameters

Parameter Type Example Description
RequestId String D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC

The ID of the request.

ConfigHistoryItems Array of ConfigHistoryItem

The change records of configuration parameters.

Time String 2022-08-22T10:00:00Z

The time when the values of the configuration parameters were modified. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

OwnerId String 253460731706911258

The UID of the Alibaba Cloud account.

Reason String test

The reason for the modification of the configuration parameters.

Success Boolean true

Indicates whether the modification of the configuration parameters took effect. Valid values:

  • true: The change took effect.
  • false: The change did not take effect.
ChangeId String 1

The ID of the change record.

Examples

Sample requests

http(s)://clickhouse.aliyuncs.com/?Action=DescribeConfigHistory
&DBClusterId=cc-bp1p816075e21****
&StartTime=2022-08-11T06:27:00Z
&EndTime=2022-08-22T10:06:00Z
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeConfigHistoryResponse>
    <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>
    <ConfigHistoryItems>
        <Time>2022-08-22T10:00:00Z</Time>
        <OwnerId>253460731706911258</OwnerId>
        <Reason>test</Reason>
        <Success>true</Success>
        <ChangeId>1</ChangeId>
    </ConfigHistoryItems>
</DescribeConfigHistoryResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.