ClickHouse提供以下API接口。
地域管理
| API | 描述 |
|---|---|
| DescribeRegions | 该接口用于查询云数据库ClickHouse所有地域和可用区的信息。 |
集群管理
| API | 描述 |
|---|---|
| CreateDBInstance | 该接口用于创建一个云数据库ClickHouse集群。 |
| DeleteDBCluster | 该接口用于释放指定的按量付费云数据库ClickHouse集群。 |
| DescribeDBClusters | 该接口用于查询查询云数据库ClickHouse指定地域的集群信息。 |
| DescribeDBClusterAttribute | 该接口用于查询指定云数据库ClickHouse集群的信息。 |
| ModifyDBClusterDescription | 该接口用于修改修改指定云数据库ClickHouse集群的名称。 |
| ModifyDBClusterMaintainTime | 该接口用于修改修改指定云数据库ClickHouse集群的可维护时间段。 |
| DescribeAllDataSource | 该接口用于枚举实例下所有Schema列表、Table列表和Columns列表。 |
| RestartInstance | 该接口用于重启指定云数据库ClickHouse集群。 |
| CheckScaleOutBalanced | 该接口用于对指定云数据库ClickHouse集群进行迁移扩容检测。 |
备份管理
| API | 描述 |
|---|---|
| CreateBackupPolicy | 该接口用于对指定云数据库ClickHouse集群进行备份设置。 |
| DescribeBackups | 该接口用于查看指定云数据库ClickHouse集群的备份集。 |
| DescribeBackupPolicy | 该接口用于查看指定云数据库ClickHouse集群的备份设置。 |
| ModifyBackupPolicy | 该接口用于修改指定云数据库ClickHouse集群的备份设置。 |
网络管理
| API | 描述 |
|---|---|
| DescribeDBClusterNetInfoItems | 该接口用于查询指定云数据库ClickHouse集群的网络信息。 |
| AllocateClusterPublicConnection | 该接口用于创建指定云数据库ClickHouse集群的公网连接地址。 |
| ReleaseClusterPublicConnection | 该接口用于释放指定云数据库ClickHouse集群的公网连接地址。 |
| CreatePortsForClickHouse | 该接口用于开通指定云数据库ClickHouse集群的MySQL端口。 |
账号管理
| API | 描述 |
|---|---|
| DescribeAccounts | 该接口用于查询指定云数据库ClickHouse集群的数据库账号信息。 |
| CreateAccount | 该接口用于为指定云数据库ClickHouse集群创建数据库账号。 |
| DeleteAccount | 该接口用于删除指定云数据库ClickHouse集群的指定数据库账号。 |
| ResetAccountPassword | 该接口用于重置指定云数据库ClickHouse集群的指定数据库账号密码。 |
| ModifyAccountDescription | 该接口用于修改指定云数据库ClickHouse集群的指定数据库账号描述。 |
安全管理
| API | 描述 |
|---|---|
| DescribeDBClusterAccessWhiteList | 该接口用于查看指定云数据库ClickHouse集群的IP白名单。 |
| ModifyDBClusterAccessWhiteList | 该接口用于修改指定云数据库ClickHouse集群的IP白名单。 |