All Products
Search
Document Center

ApsaraDB for ClickHouse:UpgradeMinorVersion

Last Updated:Jun 24, 2025

Updates the minor engine version of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:UpgradeMinorVersionupdate
*EnterpriseDBCluster
acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The cluster ID.

cc-bp1jyis8p15we****
SwitchTimeModestringNo

Specifies whether to update the minor engine version of the cluster immediately. Valid values:

  • Immediate: The system immediately performs the update.
  • MaintainTime: The system performs the update during the specified maintenance window.
  • SpecifyTime: The system performs the update at a specified time.
Immediate
SwitchTimestringNo

The update time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Note If you set SwitchTimeMode to SpecifyTime, you must configure this parameter to specify the update time.
2023-01-09T05:00:00Z
TargetMinorVersionstringNo

The minor engine version to which you want to update.

Note By default, TargetMinorVersion is not set and the minor engine version of the cluster is updated to the latest version.
23.8.1.41495_6
RegionIdstringNo

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

FE242962-6DA3-5FC8-9691-37B62A3210F7
Dataobject

The returned result.

DBInstanceNamestring

The instance ID.

cc-uf6x229yeq166****

Examples

Sample success responses

JSONformat

{
  "RequestId": "FE242962-6DA3-5FC8-9691-37B62A3210F7",
  "Data": {
    "DBInstanceName": "cc-uf6x229yeq166****"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-10-23The internal configuration of the API is changed, but the call is not affectedView Change Details