API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (clickhouse/2023-05-22) 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. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Database Management
|
API |
Title |
Description |
| CreateDB | CreateDB | Creates a database. |
| DeleteDB | DeleteDB | Call this operation to delete a database. |
Task and log management
|
API |
Title |
Description |
| DescribeProcessList | DescribeProcessList | Describes currently running queries. |
| KillProcess | KillProcess | Terminates a running task. |
| DescribeSlowLogTrend | DescribeSlowLogTrend | Queries the slow log trend. |
| DescribeSlowLogRecords | DescribeSlowLogRecords | Call DescribeSlowLogRecords to query slow log records. |
Others
|
API |
Title |
Description |
| AttachWhitelistTemplateToInstance | AttachWhitelistTemplateToInstance | Attaches a whitelist template to instances. |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group of a ClickHouse Enterprise instance. |
| CreateAccount | CreateAccount | Creates a database account for an ApsaraDB for ClickHouse Enterprise Edition cluster. |
| CreateBackupPolicy | CreateBackupPolicy | Creates a backup policy for a specified ClickHouse Enterprise Edition cluster. |
| CreateDBInstance | CreateDBInstance | To create a ClickHouse Enterprise Edition cluster, call the `CreateDBInstance` API. |
| CreateEndpoint | CreateEndpoint | Creates a public endpoint that provides a public address to access a cluster. |
| CreateWhitelistTemplate | CreateWhitelistTemplate | Creates a whitelist template. |
| DeleteAccount | DeleteAccount | Deletes a database account from an ApsaraDB for ClickHouse cluster. |
| DeleteBackupPolicy | DeleteBackupPolicy | Deletes the backup policy for a ClickHouse Enterprise Edition cluster. |
| DeleteDBInstance | DeleteDBInstance | The DeleteDBInstance operation releases an ApsaraDB for ClickHouse Enterprise Edition cluster. |
| DeleteEndpoint | DeleteEndpoint | Deletes a public endpoint. |
| DeleteWhitelistTemplate | DeleteWhitelistTemplate | Deletes a whitelist template. |
| DescribeAccountAuthority | DescribeAccountAuthority | Call the DescribeAccountAuthority operation to query the permissions of an account. |
| DescribeAccounts | DescribeAccounts | Queries database accounts for an ApsaraDB for ClickHouse cluster. |
| DescribeBackupPolicy | DescribeBackupPolicy | Queries the backup policy of a ClickHouse Enterprise Edition cluster. |
| DescribeBackups | DescribeBackups | Queries the backup sets of a ClickHouse Enterprise Edition cluster. |
| DescribeDBInstanceAttribute | DescribeDBInstanceAttribute | Call DescribeDBInstanceAttribute to query the details of an ApsaraDB for ClickHouse enterprise edition cluster. |
| DescribeDBInstanceConfig | DescribeDBInstanceConfig | Queries the parameter configuration of an instance |
| DescribeDBInstanceDataSources | DescribeDBInstanceDataSources | Queries the schema of a database or a table. |
| DescribeDBInstances | DescribeDBInstances | Call the DescribeDBInstances API to query a list of DB instances. |
| DescribeEndpoints | DescribeEndpoints | To retrieve the cluster endpoints, call DescribeEndpoints. |
| DescribeRegions | DescribeRegions | Returns information about the available regions and zones for ApsaraDB for ClickHouse. |
| DescribeSecurityIPList | DescribeSecurityIPList | Queries a whitelist. |
| DetachWhitelistTemplateToInstance | DetachWhitelistTemplateToInstance | Disassociate a whitelist template from an instance. |
| GetWhitelistTemplate | GetWhitelistTemplate | Queries the details of a whitelist template. |
| ListClickHouseDBTimezones | ListClickHouseDBTimezones | Lists the available time zones for ClickHouse. |
| ListInstanceLinkedWhitelistTemplates | ListInstanceLinkedWhitelistTemplates | Lists the IP address whitelist templates linked to an instance. |
| ListWhitelistTemplates | ListWhitelistTemplates | Queries the whitelist templates associated with an instance. |
| ModifyAccountAuthority | ModifyAccountAuthority | Modifies the permissions of a database account. |
| ModifyAccountDescription | ModifyAccountDescription | Modifies the description of a database account. |
| ModifyBackupPolicy | ModifyBackupPolicy | Modifies the backup policy of an ApsaraDB for ClickHouse cluster. |
| ModifyDBInstanceAttribute | ModifyDBInstanceAttribute | You can call the ModifyDBInstanceAttribute operation to modify the configuration of a cluster. |
| ModifyDBInstanceClass | ModifyDBInstanceClass | Call the ModifyDBInstanceClass API to modify the scaling configuration of a cluster. |
| ModifyDBInstanceConfig | ModifyDBInstanceConfig | Modifies the parameter settings for a DB instance. |
| ModifyDBInstanceConnectionString | ModifyDBInstanceConnectionString | Modifies the connection string of a cluster. |
| ModifySecurityIPList | ModifySecurityIPList | Modifies the whitelist settings of an ApsaraDB for ClickHouse cluster. |
| ResetAccountPassword | ResetAccountPassword | Resets the password of a database account for an ApsaraDB for ClickHouse Enterprise Edition cluster. |
| RestartDBInstance | RestartDBInstance | Restarts an ApsaraDB for ClickHouse Enterprise Edition cluster. |
| StartDBInstance | StartDBInstance | Starts an ApsaraDB for ClickHouse Enterprise Edition cluster. |
| StopDBInstance | StopDBInstance | Stops an ApsaraDB for ClickHouse Enterprise Edition cluster. |
| UpdateWhitelistTemplate | UpdateWhitelistTemplate | Updates a whitelist template. |
| UpgradeMinorVersion | UpgradeMinorVersion | Updates the minor engine version of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition. |
该文章对您有帮助吗？