UpgradeMinorVersion - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Updates the minor engine version of an ApsaraDB for ClickHouse cluster.

Operation description

Note You can call this operation only for ApsaraDB for ClickHouse clusters that were purchased 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
clickhouse:UpgradeMinorVersion	update	DBCluster acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	cc-bp108z124a8o7****
UpgradeImmediately	boolean	Yes	Specifies whether to update the minor engine version of the ApsaraDB for ClickHouse cluster immediately. Valid values: true: updates the minor engine version of the ApsaraDB for ClickHouse cluster immediately. false: updates the minor engine version of the ApsaraDB for ClickHouse cluster at the specified time or within the specified maintenance window. Note If you want to update the minor engine version of the ApsaraDB for ClickHouse cluster at the specified time, UpgradeTime is required.	false
UpgradeVersion	string	No	The minor engine version to which you want to update. Note By default, UpgradeVersion is not set and the minor engine version of the ApsaraDB for ClickHouse cluster is updated to the latest version.	1.37.0
UpgradeTime	string	No	The update time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in Coordinated Universal Time (UTC). Note If you do not set this parameter, the minor engine version of an ApsaraDB for ClickHouse cluster is updated within the specified maintenance window.	2022-08-07T16:38Z

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	FE242962-6DA3-5FC8-9691-37B62A3210F7

Examples

Sample success responses

JSONformat

{
  "RequestId": "FE242962-6DA3-5FC8-9691-37B62A3210F7"
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

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

Change history

Change time	Summary of changes	Operation
2024-09-23	API Description Update. The Error code has changed	View Change Details