List of operations by function - ApsaraDB for ClickHouse

This product(clickhouse/2019-11-11) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

Geographical Management

API	Title	Description
DescribeRegions	DescribeRegions	Queries the information about all regions and zones of ApsaraDB for ClickHouse clusters.

Cluster Management

API	Title	Description
CreateDBInstance	CreateDBInstance	Creates an ApsaraDB for ClickHouse cluster.
DeleteDBCluster	DeleteDBCluster	Releases a pay-as-you-go ApsaraDB for ClickHouse cluster.
DescribeDBClusters	DescribeDBClusters	Queries the information about ApsaraDB for ClickHouse clusters in a region.
DescribeDBClusterAttribute	DescribeDBClusterAttribute	Queries the information about an ApsaraDB for ClickHouse cluster.
DescribeDBClusterConfig	DescribeDBClusterConfig	Queries information about the parameter settings of an ApsaraDB for ClickHouse cluster.
ModifyDBClusterConfig	ModifyDBClusterConfig	Modifies the configurations of an ApsaraDB for ClickHouse cluster.
DescribeDBConfig	DescribeDBConfig	Queries configuration information about an ApsaraDB for ClickHouse cluster.
ModifyDBCluster	ModifyDBCluster	Upgrades or downgrades an ApsaraDB for ClickHouse cluster.
ModifyDBClusterDescription	ModifyDBClusterDescription	Changes the name of an ApsaraDB for ClickHouse cluster.
ModifyDBClusterMaintainTime	ModifyDBClusterMaintainTime	Modifies the maintenance window of an ApsaraDB for ClickHouse cluster.
DescribeAllDataSources	DescribeAllDataSources	Queries the data sources of an ApsaraDB for ClickHouse cluster.
DescribeAllDataSource	DescribeAllDataSource	Queries a list of databases, tables, and columns in an ApsaraDB for ClickHouse cluster.
DescribeSchemas	DescribeSchemas	Queries a list of all databases in an ApsaraDB for ClickHouse cluster.
DescribeTables	DescribeTables	Queries the information about tables in a database of an ApsaraDB for ClickHouse cluster.
DescribeColumns	DescribeColumns	Queries information about columns.
RestartInstance	RestartInstance	Restarts an ApsaraDB for ClickHouse cluster.
CheckScaleOutBalanced	CheckScaleOutBalanced	Performs migration and scale-out detection on an ApsaraDB for ClickHouse cluster.
CreateOSSStorage	CreateOSSStorage	Creates a storage task for cold data.
DescribeOSSStorage	DescribeOSSStorage	Queries the storage of cold data.
CheckClickhouseToRDS	CheckClickhouseToRDS	Checks the connectivity between an ApsaraDB for ClickHouse cluster and an ApsaraDB RDS for MySQL instance.
DescribeSynDbs	DescribeSynDbs	Queries the information about data synchronization between an ApsaraDB for ClickHouse cluster and an ApsaraDB RDS for MySQL instance.
DescribeSynDbTables	DescribeSynDbTables	Queries information about tables that are synchronized from an ApsaraDB RDS for MySQL instance to an ApsaraDB for ClickHouse cluster.
DeleteSyndb	DeleteSyndb	Deletes a database used for data synchronization.
DescribeTransferHistory	DescribeTransferHistory	Queries information about data migration from an ApsaraDB for ClickHouse cluster of an earlier version to an ApsaraDB for ClickHouse cluster of a later version
TransferVersion	TransferVersion	Migrates the data of a source ApsaraDB for ClickHouse cluster to a destination ApsaraDB for ClickHouse cluster.
CreateServiceLinkedRole	CreateServiceLinkedRole	Creates a service-linked role.
KillProcess	KillProcess	Terminates an ongoing task.
DescribeSlowLogRecords	DescribeSlowLogRecords	Queries the details about slow query logs.
DescribeDBClusterPerformance	DescribeDBClusterPerformance	Queries performance data about an ApsaraDB for ClickHouse cluster.
UpgradeMinorVersion	UpgradeMinorVersion	Updates the minor engine version of an ApsaraDB for ClickHouse cluster.
DescribeDBClusterConfigInXML	DescribeDBClusterConfigInXML	Queries the values of the configuration parameters in the config.xml file of an ApsaraDB for ClickHouse cluster.
ModifyDBClusterConfigInXML	ModifyDBClusterConfigInXML	Modifies the settings of the configuration parameters for an ApsaraDB for ClickHouse cluster.
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.
DescribeConfigHistory	DescribeConfigHistory	Queries the change records of the configuration parameters of an ApsaraDB for ClickHouse cluster.
DescribeConfigVersionDifference	DescribeConfigVersionDifference	Queries the values of the configuration parameters of an ApsaraDB for ClickHouse cluster before and after the values of the configuration parameters are changed.
CreateRDSToClickhouseDb	CreateRDSToClickhouseDb	Creates a task to synchronize data from an ApsaraDB RDS for MySQL instance to an ApsaraDB for ClickHouse cluster.
ModifyDBConfig	ModifyDBConfig	Modifies the dictionary configuration of an ApsaraDB for ClickHouse cluster.
ModifyRDSToClickhouseDb	ModifyRDSToClickhouseDb	Modifies the synchronization task of an ApsaraDB for ClickHouse cluster.
DescribeProcessList	DescribeProcessList	Queries the details of queries that are being executed in an ApsaraDB for ClickHouse cluster.

Backup Management

API	Title	Description
CreateBackupPolicy	CreateBackupPolicy	Creates a backup policy.
ModifyBackupPolicy	ModifyBackupPolicy	Modifies the backup settings of an ApsaraDB for ClickHouse cluster.
DescribeBackupPolicy	DescribeBackupPolicy	Queries the backup settings of an ApsaraDB for ClickHouse cluster.

Network Management

API	Title	Description
CreatePortsForClickHouse	CreatePortsForClickHouse	Enables the MySQL port for an ApsaraDB for ClickHouse cluster.
ReleaseClusterPublicConnection	ReleaseClusterPublicConnection	Releases the public endpoint of an ApsaraDB for ClickHouse cluster.
AllocateClusterPublicConnection	AllocateClusterPublicConnection	Creates a public endpoint for an ApsaraDB for ClickHouse cluster.
DescribeDBClusterNetInfoItems	DescribeDBClusterNetInfoItems	Queries the network information about an ApsaraDB for ClickHouse cluster.

Account Management

API	Title	Description
CreateAccount	CreateAccount	Creates a database account for an ApsaraDB for ClickHouse cluster.
CreateSQLAccount	CreateSQLAccount	Creates a privileged account or a standard account for an ApsaraDB for ClickHouse cluster.
DeleteAccount	DeleteAccount	Deletes a database account of an ApsaraDB for ClickHouse cluster.
ResetAccountPassword	ResetAccountPassword	Resets the password of a database account for an ApsaraDB for ClickHouse cluster.
DescribeAccountAuthority	DescribeAccountAuthority	Queries the permissions of an account.
ModifyAccountAuthority	ModifyAccountAuthority	Modifies the permissions of an account.

Safety Management

API	Title	Description
DescribeDBClusterAccessWhiteList	DescribeDBClusterAccessWhiteList	Queries the IP address whitelist of an ApsaraDB for ClickHouse cluster.
CreateMonitorDataReport	CreateMonitorDataReport	Creates a monitoring data report for an ApsaraDB for ClickHouse cluster.
CheckMonitorAlert	CheckMonitorAlert	Checks whether the monitoring and alerting feature that is provided by Application Real-Time Monitoring Service (ARMS) is enabled for an ApsaraDB for ClickHouse cluster.

Other

API	Title	Description
CheckServiceLinkedRole	CheckServiceLinkedRole	Queries the service-linked role of ApsaraDB for ClickHouse.