All Products
Search
Document Center

ApsaraDB for ClickHouse:DescribeConfigHistory

Last Updated:Nov 12, 2024

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
clickhouse:DescribeConfigHistoryget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

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****
StartTimestringYes

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
EndTimestringYes

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

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC
ConfigHistoryItemsarray<object>

The change records of the configuration parameters.

ConfigHistoryItemobject
Timestring

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
OwnerIdstring

The user ID (UID) of the Alibaba Cloud account.

253460731706911258
Reasonstring

The reason for the setting modification of the configuration parameters.

test
Successboolean

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

  • true
  • false
true
ChangeIdstring

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 codeError codeError message
400IdempotentParameterMismatchThe 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 timeSummary of changesOperation
2024-09-25API Description Update. The Error code has changedView Change Details
2022-09-22Add OperationView Change Details