All Products
Search

This Product

    ApsaraDB for ClickHouse:List of operations by function

    Document Center

    ApsaraDB for ClickHouse:List of operations by function

    Last Updated:Dec 05, 2024
    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

    APITitleDescription
    DescribeRegionsDescribeRegionsQueries the information about all regions and zones of ApsaraDB for ClickHouse clusters.

    Cluster Management

    APITitleDescription
    CreateDBInstanceCreateDBInstanceCreates an ApsaraDB for ClickHouse cluster.
    DeleteDBClusterDeleteDBClusterReleases a pay-as-you-go ApsaraDB for ClickHouse cluster.
    DescribeDBClustersDescribeDBClustersQueries the information about ApsaraDB for ClickHouse clusters in a region.
    DescribeDBClusterAttributeDescribeDBClusterAttributeQueries the information about an ApsaraDB for ClickHouse cluster.
    DescribeDBClusterConfigDescribeDBClusterConfigQueries information about the parameter settings of an ApsaraDB for ClickHouse cluster.
    ModifyDBClusterConfigModifyDBClusterConfigModifies the configurations of an ApsaraDB for ClickHouse cluster.
    DescribeDBConfigDescribeDBConfigQueries configuration information about an ApsaraDB for ClickHouse cluster.
    ModifyDBClusterModifyDBClusterUpgrades or downgrades an ApsaraDB for ClickHouse cluster.
    ModifyDBClusterDescriptionModifyDBClusterDescriptionChanges the name of an ApsaraDB for ClickHouse cluster.
    ModifyDBClusterMaintainTimeModifyDBClusterMaintainTimeModifies the maintenance window of an ApsaraDB for ClickHouse cluster.
    DescribeAllDataSourcesDescribeAllDataSourcesQueries the data sources of an ApsaraDB for ClickHouse cluster.
    DescribeAllDataSourceDescribeAllDataSourceQueries a list of databases, tables, and columns in an ApsaraDB for ClickHouse cluster.
    DescribeSchemasDescribeSchemasQueries a list of all databases in an ApsaraDB for ClickHouse cluster.
    DescribeTablesDescribeTablesQueries the information about tables in a database of an ApsaraDB for ClickHouse cluster.
    DescribeColumnsDescribeColumnsQueries information about columns.
    RestartInstanceRestartInstanceRestarts an ApsaraDB for ClickHouse cluster.
    CheckScaleOutBalancedCheckScaleOutBalancedPerforms migration and scale-out detection on an ApsaraDB for ClickHouse cluster.
    CreateOSSStorageCreateOSSStorageCreates a storage task for cold data.
    DescribeOSSStorageDescribeOSSStorageQueries the storage of cold data.
    CheckClickhouseToRDSCheckClickhouseToRDSChecks the connectivity between an ApsaraDB for ClickHouse cluster and an ApsaraDB RDS for MySQL instance.
    DescribeSynDbsDescribeSynDbsQueries the information about data synchronization between an ApsaraDB for ClickHouse cluster and an ApsaraDB RDS for MySQL instance.
    DescribeSynDbTablesDescribeSynDbTablesQueries information about tables that are synchronized from an ApsaraDB RDS for MySQL instance to an ApsaraDB for ClickHouse cluster.
    DeleteSyndbDeleteSyndbDeletes a database used for data synchronization.
    DescribeTransferHistoryDescribeTransferHistoryQueries information about data migration from an ApsaraDB for ClickHouse cluster of an earlier version to an ApsaraDB for ClickHouse cluster of a later version
    TransferVersionTransferVersionMigrates the data of a source ApsaraDB for ClickHouse cluster to a destination ApsaraDB for ClickHouse cluster.
    CreateServiceLinkedRoleCreateServiceLinkedRoleCreates a service-linked role.
    KillProcessKillProcessTerminates an ongoing task.
    DescribeSlowLogRecordsDescribeSlowLogRecordsQueries the details about slow query logs.
    DescribeDBClusterPerformanceDescribeDBClusterPerformanceQueries performance data about an ApsaraDB for ClickHouse cluster.
    UpgradeMinorVersionUpgradeMinorVersionUpdates the minor engine version of an ApsaraDB for ClickHouse cluster.
    DescribeDBClusterConfigInXMLDescribeDBClusterConfigInXMLQueries the values of the configuration parameters in the config.xml file of an ApsaraDB for ClickHouse cluster.
    ModifyDBClusterConfigInXMLModifyDBClusterConfigInXMLModifies the settings of the configuration parameters for an ApsaraDB for ClickHouse cluster.
    CheckModifyConfigNeedRestartCheckModifyConfigNeedRestartQueries whether an ApsaraDB for ClickHouse cluster needs to be restarted after you change the values of the configuration parameters in XML mode.
    DescribeConfigHistoryDescribeConfigHistoryQueries the change records of the configuration parameters of an ApsaraDB for ClickHouse cluster.
    DescribeConfigVersionDifferenceDescribeConfigVersionDifferenceQueries the values of the configuration parameters of an ApsaraDB for ClickHouse cluster before and after the values of the configuration parameters are changed.
    CreateRDSToClickhouseDbCreateRDSToClickhouseDbCreates a task to synchronize data from an ApsaraDB RDS for MySQL instance to an ApsaraDB for ClickHouse cluster.
    ModifyDBConfigModifyDBConfigModifies the dictionary configuration of an ApsaraDB for ClickHouse cluster.
    ModifyRDSToClickhouseDbModifyRDSToClickhouseDbModifies the synchronization task of an ApsaraDB for ClickHouse cluster.
    DescribeProcessListDescribeProcessListQueries the details of queries that are being executed in an ApsaraDB for ClickHouse cluster.

    Backup Management

    APITitleDescription
    CreateBackupPolicyCreateBackupPolicyCreates a backup policy.
    ModifyBackupPolicyModifyBackupPolicyModifies the backup settings of an ApsaraDB for ClickHouse cluster.
    DescribeBackupPolicyDescribeBackupPolicyQueries the backup settings of an ApsaraDB for ClickHouse cluster.

    Network Management

    APITitleDescription
    CreatePortsForClickHouseCreatePortsForClickHouseEnables the MySQL port for an ApsaraDB for ClickHouse cluster.
    ReleaseClusterPublicConnectionReleaseClusterPublicConnectionReleases the public endpoint of an ApsaraDB for ClickHouse cluster.
    AllocateClusterPublicConnectionAllocateClusterPublicConnectionCreates a public endpoint for an ApsaraDB for ClickHouse cluster.
    DescribeDBClusterNetInfoItemsDescribeDBClusterNetInfoItemsQueries the network information about an ApsaraDB for ClickHouse cluster.

    Account Management

    APITitleDescription
    CreateAccountCreateAccountCreates a database account for an ApsaraDB for ClickHouse cluster.
    CreateSQLAccountCreateSQLAccountCreates a privileged account or a standard account for an ApsaraDB for ClickHouse cluster.
    DeleteAccountDeleteAccountDeletes a database account of an ApsaraDB for ClickHouse cluster.
    ResetAccountPasswordResetAccountPasswordResets the password of a database account for an ApsaraDB for ClickHouse cluster.
    DescribeAccountAuthorityDescribeAccountAuthorityQueries the permissions of an account.
    ModifyAccountAuthorityModifyAccountAuthorityModifies the permissions of an account.

    Safety Management

    APITitleDescription
    DescribeDBClusterAccessWhiteListDescribeDBClusterAccessWhiteListQueries the IP address whitelist of an ApsaraDB for ClickHouse cluster.
    CreateMonitorDataReportCreateMonitorDataReportCreates a monitoring data report for an ApsaraDB for ClickHouse cluster.
    CheckMonitorAlertCheckMonitorAlertChecks 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

    APITitleDescription
    CheckServiceLinkedRoleCheckServiceLinkedRoleQueries the service-linked role of ApsaraDB for ClickHouse.