API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (clickhouse/2019-11-11) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Geographical Management
|
API |
Title |
Description |
| DescribeRegions | DescribeRegions | Queries the available regions and zones for ApsaraDB for ClickHouse. |
Backup Management
|
API |
Title |
Description |
| CreateBackupPolicy | CreateBackupPolicy | Creates a backup policy. |
| ModifyBackupPolicy | ModifyBackupPolicy | Modifies the backup settings of a specified ApsaraDB for ClickHouse cluster. |
| DescribeBackupPolicy | DescribeBackupPolicy | Queries the backup settings for a specified ApsaraDB for ClickHouse cluster. |
| DescribeBackups | DescribeBackups | Queries the backup sets of a specified ApsaraDB for ClickHouse cluster. |
Network Management
|
API |
Title |
Description |
| CreatePortsForClickHouse | CreatePortsForClickHouse | Enables the MySQL or HTTPS port for a specified ApsaraDB for ClickHouse cluster. |
| ReleaseClusterPublicConnection | ReleaseClusterPublicConnection | Releases the public endpoint of a specified ApsaraDB for ClickHouse cluster. |
| AllocateClusterPublicConnection | AllocateClusterPublicConnection | Allocates a public endpoint for a specified ApsaraDB for ClickHouse cluster. |
| DescribeDBClusterNetInfoItems | DescribeDBClusterNetInfoItems | Queries the network information for a specified ApsaraDB for ClickHouse cluster. |
Account Management
|
API |
Title |
Description |
| DescribeAccounts | DescribeAccounts | Describes the database accounts of a specified ApsaraDB for ClickHouse cluster. |
| CreateAccount | CreateAccount | Creates a database account for an ApsaraDB for ClickHouse cluster. |
| CreateSQLAccount | CreateSQLAccount | Call the CreateSQLAccount operation to create a privileged or standard account for an ApsaraDB for ClickHouse cluster. |
| DeleteAccount | DeleteAccount | Deletes a database account from an ApsaraDB for ClickHouse cluster. |
| ResetAccountPassword | ResetAccountPassword | Resets the password of a database account in a specified ApsaraDB for ClickHouse cluster. |
| ModifyAccountDescription | ModifyAccountDescription | Modifies the description of a database account in an ApsaraDB for ClickHouse cluster. |
| CreateAccountAndAuthority | CreateAccountAndAuthority | Creates an account and grants permissions. |
| DescribeAccountAuthority | DescribeAccountAuthority | Describes the permissions of a database account. |
| ModifyAccountAuthority | ModifyAccountAuthority | Modifies the permissions of a database account. |
Safety Management
|
API |
Title |
Description |
| DescribeDBClusterAccessWhiteList | DescribeDBClusterAccessWhiteList | Queries the IP address whitelist of a specified ApsaraDB for ClickHouse cluster. |
| ModifyDBClusterAccessWhiteList | ModifyDBClusterAccessWhiteList | Modifies the IP address whitelist for a specified ApsaraDB for ClickHouse cluster. |
| CreateMonitorDataReport | CreateMonitorDataReport | Creates a monitoring data report. |
| CheckMonitorAlert | CheckMonitorAlert | Call the CheckMonitorAlert operation to check whether the alert monitoring feature of Application Real-Time Monitoring Service (ARMS) is enabled for a specified ApsaraDB for ClickHouse cluster. |
Other
|
API |
Title |
Description |
| CheckServiceLinkedRole | CheckServiceLinkedRole | Queries the service-linked role for ApsaraDB for ClickHouse. |
| ModifyMinorVersionGreadeType | ModifyMinorVersionGreadeType | Modifies the upgrade type for a ClickHouse minor version to automatic or manual. |
Others
|
API |
Title |
Description |
| CancelActiveOperationTasks | CancelActiveOperationTasks | Cancels tasks for O&M events. |
| CancelAppointmentElectZookeeperLeader | CancelAppointmentElectZookeeperLeader | Cancels a scheduled ZooKeeper leader switchover on a community-compatible ClickHouse instance. |
| CancelAppointmentRestartInstanceNodeList | CancelAppointmentRestartInstanceNodeList | Cancels the scheduled restart on the specified ClickHouse nodes. |
| CancelRestartInstance | CancelRestartInstance | Cancels a scheduled restart for a specific community-compatible ApsaraDB for ClickHouse cluster. |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group of a community-edition compatible ClickHouse cluster. |
| CheckClickhouseToRDS | CheckClickhouseToRDS | Call the CheckClickhouseToRDS operation to verify the connectivity between a community-compatible ApsaraDB for ClickHouse cluster and an ApsaraDB RDS for MySQL instance. |
| CheckModifyConfigNeedRestart | CheckModifyConfigNeedRestart | Queries whether an ApsaraDB for ClickHouse cluster needs to be restarted after you change the values of the configuration parameters in XML mode. |
| CheckScaleOutBalanced | CheckScaleOutBalanced | Checks whether a specified ApsaraDB for ClickHouse cluster can be scaled out. |
| CreateDBInstance | CreateDBInstance | Creates an ApsaraDB for ClickHouse cluster. |
| CreateOSSStorage | CreateOSSStorage | Creates a cold storage space. |
| CreateRDSToClickhouseDb | CreateRDSToClickhouseDb | You can call the CreateRDSToClickhouseDb operation to create a sync task for an ApsaraDB for ClickHouse Community-Compatible Edition cluster. |
| CreateSLB | CreateSLB | Calls the CreateSLB operation to attach a Server Load Balancer (SLB) instance to a specified ApsaraDB for ClickHouse Community-Compatible Edition cluster. |
| CreateServiceLinkedRole | CreateServiceLinkedRole | Creates a service-linked role. |
| DeleteBackupPolicy | DeleteBackupPolicy | Deletes the backup policy for a community-compatible ApsaraDB for ClickHouse cluster. |
| DeleteDBCluster | DeleteDBCluster | Deletes a specified pay-as-you-go ApsaraDB for ClickHouse cluster. |
| DeleteSLB | DeleteSLB | Releases a Server Load Balancer (SLB) instance for a specified ApsaraDB for ClickHouse Community-Compatible cluster. |
| DeleteSyndb | DeleteSyndb | Deletes a database synchronization task. |
| DescribeActiveOperationMaintainConf | DescribeActiveOperationMaintainConf | Queries the active Operations and Maintenance (O&M) configuration of a ClickHouse instance. |
| DescribeActiveOperationTasks | DescribeActiveOperationTasks | Queries the active operation tasks of a ClickHouse instance. |
| DescribeAllDataSource | DescribeAllDataSource | Describes all databases, tables, and columns in an instance. |
| DescribeAllDataSources | DescribeAllDataSources | Queries the details of all data sources. |
| DescribeAutoRenewAttribute | DescribeAutoRenewAttribute | Queries the auto-renewal status of a ClickHouse Community-Compatible cluster. |
| DescribeColumns | DescribeColumns | You can view columns. |
| DescribeConfigHistory | DescribeConfigHistory | Call the DescribeConfigHistory operation to view the configuration parameter change history of a community-compatible ApsaraDB for ClickHouse cluster. |
| DescribeConfigVersionDifference | DescribeConfigVersionDifference | Call the DescribeConfigVersionDifference operation to compare the parameter values of an ApsaraDB for ClickHouse community-compatible cluster before and after a configuration change. |
| DescribeDBClusterAttribute | DescribeDBClusterAttribute | Queries information about an ApsaraDB for ClickHouse cluster. |
| DescribeDBClusterConfig | DescribeDBClusterConfig | The DescribeDBClusterConfig operation queries the parameter configuration of a community-compatible ClickHouse cluster. |
| DescribeDBClusterConfigInXML | DescribeDBClusterConfigInXML | You can call the DescribeDBClusterConfigInXML operation to query the configuration parameters of an ApsaraDB for ClickHouse Community-Compatible Edition cluster in XML format. |
| DescribeDBClusterPerformance | DescribeDBClusterPerformance | Views the performance data of an ApsaraDB for ClickHouse Community-Compatible Edition cluster. |
| DescribeDBClusterStatusSet | DescribeDBClusterStatusSet | This operation queries the status set of a ClickHouse Community-Compatible Edition cluster. |
| DescribeDBClusters | DescribeDBClusters | Describes ApsaraDB for ClickHouse clusters in a specified region. |
| DescribeDBConfig | DescribeDBConfig | The DescribeDBConfig operation queries the configuration of a community-compatible cluster. |
| DescribeEventMetaInfo | DescribeEventMetaInfo | Queries the metadata of Operations and Maintenance (O&M) events for a ClickHouse-compatible cluster. |
| DescribeOSSStorage | DescribeOSSStorage | Queries cold storage information. |
| DescribeProcessList | DescribeProcessList | Call the DescribeProcessList operation to retrieve running queries on an ApsaraDB for ClickHouse Community-Compatible cluster. |
| DescribeSchemas | DescribeSchemas | Queries all databases in an instance. |
| DescribeSlowLogRecords | DescribeSlowLogRecords | Queries the details of slow query logs. |
| DescribeSlowLogTrend | DescribeSlowLogTrend | Queries statistics about the slow log trends for a cluster. |
| DescribeSynDbTables | DescribeSynDbTables | Queries synchronized databases and tables. |
| DescribeSynDbs | DescribeSynDbs | Queries information about synchronized databases. |
| DescribeTables | DescribeTables | You can call the DescribeTables operation to query tables in a community-compatible cluster. |
| DescribeTransferHistory | DescribeTransferHistory | Queries the migration history. |
| DescribeUserEncryptionKeyList | DescribeUserEncryptionKeyList | Retrieves a list of your KMS keys. |
| KillProcess | KillProcess | Stops ongoing tasks. |
| ListTagResources | ListTagResources | Lists the tags that are attached to ApsaraDB for ClickHouse clusters. |
| ModifyActiveOperationMaintainConf | ModifyActiveOperationMaintainConf | Modifies the configuration of active O&M tasks on a community-compatible ClickHouse cluster. |
| ModifyActiveOperationTasks | ModifyActiveOperationTasks | Modifies the switch time for operations and maintenance (O&M) events on a ClickHouse Community-compatible cluster. |
| ModifyAutoRenewAttribute | ModifyAutoRenewAttribute | Modifies the auto-renewal status of a ClickHouse Community-Compatible cluster. |
| ModifyDBCluster | ModifyDBCluster | Modifies the specifications of a cluster. |
| ModifyDBClusterConfig | ModifyDBClusterConfig | Modifies the configuration of a cluster. |
| ModifyDBClusterConfigInXML | ModifyDBClusterConfigInXML | Modifies the configuration parameters of a specified community-compatible ApsaraDB for ClickHouse cluster. |
| ModifyDBClusterDescription | ModifyDBClusterDescription | Changes the description of a specified ApsaraDB for ClickHouse cluster. |
| ModifyDBClusterMaintainTime | ModifyDBClusterMaintainTime | Modifies the maintenance window for a specified ApsaraDB for ClickHouse cluster. |
| ModifyDBConfig | ModifyDBConfig | The ModifyDBConfig operation modifies the dictionary configuration of a community-compatible cluster. |
| ModifyRDSToClickhouseDb | ModifyRDSToClickhouseDb | Modifies the sync task of a community-compatible ApsaraDB for ClickHouse cluster. |
| RestartInstance | RestartInstance | Restarts a specified ApsaraDB for ClickHouse cluster. |
| RestartInstanceNodeList | RestartInstanceNodeList | Restarts multiple nodes in an instance that is compatible with ClickHouse Community. |
| TagResources | TagResources | Creates and attaches tags to one or more ApsaraDB for ClickHouse clusters. |
| TransferVersion | TransferVersion | Migration between versions. |
| UntagResources | UntagResources | Removes tags from ApsaraDB for ClickHouse clusters. |
| UpgradeMinorVersion | UpgradeMinorVersion | The UpgradeMinorVersion operation upgrades the minor engine version of a specified community-compatible ApsaraDB for ClickHouse cluster. |