All Products
Search
Document Center

:List of operations by function

Last Updated:Apr 14, 2023

The following tables list the API operations available for use in ApsaraDB for ClickHouse.

Region management

API operation

Description

DescribeRegions

Queries information about all regions and zones of ApsaraDB for ClickHouse.

Cluster management

API operation

Description

CreateDBInstance

Creates an ApsaraDB for ClickHouse cluster.

DeleteDBCluster

Releases a specified pay-as-you-go ApsaraDB for ClickHouse cluster.

DescribeDBClusters

Queries information about ApsaraDB for ClickHouse clusters in a specified region.

DescribeDBClusterAttribute

Queries information about a specified ApsaraDB for ClickHouse cluster.

DescribeDBClusterConfig

Queries information about the parameter settings of an ApsaraDB for ClickHouse cluster.

ModifyDBClusterConfig

Changes a parameter value that is specified for an ApsaraDB for ClickHouse cluster.

DescribeDBConfig

Queries the dictionary configuration of an ApsaraDB for ClickHouse cluster.

ModifyDBCluster

Modifies the configuration of an ApsaraDB for ClickHouse cluster.

ModifyDBClusterDescription

Changes the name of a specified ApsaraDB for ClickHouse cluster.

ModifyDBClusterMaintainTime

Changes the maintenance window of an ApsaraDB for ClickHouse cluster.

DescribeAllDataSources

Queries the database, table, and column information about an ApsaraDB for ClickHouse cluster.

DescribeAllDataSource

DescribeSchemas

Queries information about the databases of an ApsaraDB for ClickHouse cluster.

DescribeTables

Queries information about tables in a specified database of an ApsaraDB for ClickHouse cluster.

DescribeColumns

Queries information about the columns of a specified table that is in a specified database of an ApsaraDB for ClickHouse cluster.

RestartInstance

Restarts an ApsaraDB for ClickHouse cluster.

CheckScaleOutBalanced

Checks whether an ApsaraDB for ClickHouse cluster is ready for a scale-out operation that is performed in the cluster.

CreateOSSStorage

Enables tiered storage of hot data and cold data for an ApsaraDB for ClickHouse cluster.

DescribeOSSStorage

Checks whether tiered storage of hot data and cold data is enabled for an ApsaraDB for ClickHouse cluster.

CheckClickhouseToRDS

Checks whether an ApsaraDB for ClickHouse cluster can be connected to an ApsaraDB RDS instance.ApsaraDB for ClickHouse

DescribeSynDbs

Queries information about data synchronization between an ApsaraDB for ClickHouse cluster and an ApsaraDB RDS for MySQL instance.ApsaraDB for ClickHouse

DescribeSynDbTables

Queries information about tables that are synchronized between two ApsaraDB for ClickHouse clusters.ApsaraDB for ClickHouse

DeleteSyndb

Deletes a task that synchronizes data from an ApsaraDB RDS for MySQL instance to an ApsaraDB for ClickHouse cluster.ApsaraDB for ClickHouse

DescribeTransferHistory

Queries the data migration status of the destination ApsaraDB for ClickHouse cluster.

TransferVersion

Migrates data from an ApsaraDB for ClickHouse cluster of a specified version to an ApsaraDB for ClickHouse cluster of a later version.

CreateServiceLinkedRole

Creates a service-linked role.

KillProcess

Stops one or more query statements that are being executed on an ApsaraDB for ClickHouse cluster.

DescribeSlowLogRecords

Queries the slow query tasks of an ApsaraDB for ClickHouse cluster.

DescribeSlowLogTrend

Queries the trend of slow SQL queries in an ApsaraDB for ClickHouse cluster.

DescribeDBClusterPerformance

Queries performance data about an ApsaraDB for ClickHouse cluster.

UpgradeMinorVersion

Updates the minor engine version of a specified ApsaraDB for ClickHouse cluster.

DescribeDBClusterConfigInXML

Queries the values of the configuration parameters in the config.xml file of a specified ApsaraDB for ClickHouse cluster.

ModifyDBClusterConfigInXML

Changes the values of the configuration parameters in the config.xml file of a specified ApsaraDB for ClickHouse cluster.

CheckModifyConfigNeedRestart

Queries whether an ApsaraDB for ClickHouse cluster needs to be restarted after you change the values of the configuration parameters in the config.xml file.

DescribeConfigHistory

Queries the change records of configuration parameters of an ApsaraDB for ClickHouse cluster.

DescribeConfigVersionDifference

Queries the values of configuration parameters of an ApsaraDB for ClickHouse cluster before and after the values of the configuration parameters are changed.

CreateSLB

Adds Server Load Balancer (SLB) instances to an ApsaraDB for ClickHouse cluster.

DeleteSLB

Removes SLB instances from an ApsaraDB for ClickHouse cluster.

Backup management

API operation

Description

CreateBackupPolicy

Configures backup settings for an ApsaraDB for ClickHouse cluster.

DescribeBackups

Queries the backup sets of an ApsaraDB for ClickHouse cluster.

DescribeBackupPolicy

Queries the backup settings of an ApsaraDB for ClickHouse cluster.

ModifyBackupPolicy

Modifies the backup settings of an ApsaraDB for ClickHouse cluster.

Network management

API operation

Description

DescribeDBClusterNetInfoItems

Queries network information about an ApsaraDB for ClickHouse cluster.

AllocateClusterPublicConnection

Creates a public endpoint for an ApsaraDB for ClickHouse cluster.

ReleaseClusterPublicConnection

Releases a public endpoint of an ApsaraDB for ClickHouse cluster.

CreatePortsForClickHouse

Enables a MySQL port for an ApsaraDB for ClickHouse cluster.

Account management

API operation

Description

DescribeAccounts

Queries the database accounts of an ApsaraDB for ClickHouse cluster.

CreateAccount

Creates a database account for an ApsaraDB for ClickHouse cluster.

CreateSQLAccount

Creates a privileged account or a standard account for an ApsaraDB for ClickHouse cluster.

DeleteAccount

Deletes a specified database account of an ApsaraDB for ClickHouse cluster.

ResetAccountPassword

Resets the password of a specified database account for an ApsaraDB for ClickHouse cluster.

ModifyAccountDescription

Modifies the description of a specified database account for an ApsaraDB for ClickHouse cluster.

CreateAccountAndAuthority

Creates a database account for an ApsaraDB for ClickHouse cluster and grants permissions to the database account.

DescribeAccountAuthority

Queries the permissions that are granted to a specified database account for a single ApsaraDB for ClickHouse cluster.

ModifyAccountAuthority

Modifies the permissions that are granted to a specified database account for a single ApsaraDB for ClickHouse cluster.

Security management

API operation

Description

DescribeDBClusterAccessWhiteList

Queries the IP address whitelist of an ApsaraDB for ClickHouse cluster.

ModifyDBClusterAccessWhiteList

Modifies the IP address whitelist of an ApsaraDB for ClickHouse cluster.

CreateMonitorDataReport

Enables the monitoring and alerting feature that is provided by Application Real-Time Monitoring Service (ARMS) for an ApsaraDB for ClickHouse cluster.

CheckMonitorAlert

Checks whether the monitoring and alerting feature that is provided by ARMS is enabled for an ApsaraDB for ClickHouse cluster.