UpgradeMinorVersion - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Operation description

Note

Minor engine version upgrades are supported only for community-compatible clusters that are purchased 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:UpgradeMinorVersion

update

*DBCluster

acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	cc-bp108z124a8o7****
UpgradeImmediately	boolean	Yes	Specifies whether to upgrade the minor engine version immediately. Valid values: true: The minor engine version is upgraded immediately. false: The minor engine version is upgraded at a specified time or within the maintenance window. Note The UpgradeTime parameter is required if you want to upgrade the minor engine version at a specified time.	false
UpgradeVersion	string	No	The minor engine version to which you want to upgrade. Note If you do not specify this parameter, the cluster is upgraded to the latest minor engine version.	1.37.0
UpgradeTime	string	No	The time to perform the upgrade. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. Note If you do not specify this parameter, the ApsaraDB for ClickHouse cluster is upgraded within the maintenance window.	2022-08-07T16:38Z

Response elements

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

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.