DescribeConfigHistory - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Operation description

Note

This operation supports only community-compatible clusters that are created after December 1, 2021.

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:DescribeConfigHistory

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Call the DescribeDBClusters operation to query the information about all clusters in a specific region, including cluster IDs.	cc-bp1p816075e21****
StartTime	string	Yes	The start of the time range to query. Use the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.	2022-08-11T06:27:00Z
EndTime	string	Yes	The end of the time range to query. Use the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.	2022-08-22T10:06:00Z

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC
ConfigHistoryItems	array<object>	The change history of the configuration parameters.
	object
Time	string	The time when the change was made. Use the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.	2022-08-22T10:00:00Z
OwnerId	string	The UID of the Alibaba Cloud account.	253460731706911258
Reason	string	The reason for the parameter change.	test
Success	boolean	Indicates whether the parameter change took effect. Valid values: true: The change took effect. false: The change did not take effect.	true
ChangeId	string	The ID of the change record.	1

Examples

Success response

JSON format

{
  "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	Description
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.