# Alibaba Cloud ApsaraDB for ClickHouse API

> Alibaba Cloud ApsaraDB for ClickHouse API on Apizie: 71 endpoints (Attaches a whitelist template to instances, Changes the resource group of a ClickHouse Enterprise instance, Creates a database account for an ApsaraDB for ClickHouse Enterprise Edition cluster, Creates a backup policy for a specified ClickHouse Enterprise Edition cluster, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-clickhouse`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/clickhouse
- Page: https://zieapi.vercel.app/api/cloud/aliyun-clickhouse
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-clickhouse/openapi.json

Alibaba Cloud OpenAPI for ApsaraDB for ClickHouse (clickhouse, version 2023-05-22). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Attaches a whitelist template to instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/attach-whitelist-template-to-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | Region ID |
| TemplateId | string | yes | The ID of the whitelist template |
| DBInstanceId | string | yes | The ClickHouse instance ID. Separate multiple instance IDs with commas. A maximum of 20 instances can be attached at a time |

### Changes the resource group of a ClickHouse Enterprise instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceType | string | no | The resource type |
| ResourceId | string | yes | The resource ID |
| ResourceRegionId | string | yes | The region ID |
| ResourceGroupId | string | yes | The ID of the destination resource group |

### Creates a database account for an ApsaraDB for ClickHouse Enterprise Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/create-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID |
| AccountType | string | yes | The type of the database account. Valid values: NormalAccount: Standard account. SuperAccount: Privileged account |
| Account | string | yes | The database account. The account name must meet the following requirements: The name must be unique. The name can contain lowercase… |
| Password | string | yes | The password of the database account. The password must meet the following requirements: The password must contain at least three of the… |
| DmlAuthSetting | string | no | The authorization information (JSON-encoded) |
| RegionId | string | yes | The region ID |
| Product | string | no | The product code |
| Description | string | no | The description |

### Creates a backup policy for a specified ClickHouse Enterprise Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/create-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID |
| RegionId | string | yes | The region ID |
| PreferredBackupTime | string | yes | The UTC time range to perform the backup. For example, `12:00Z-13:00Z` means that the backup starts between 12:00 and 13:00 UTC |
| PreferredBackupPeriod | string | yes | The backup cycle. Specify the days of the week for backups. Separate multiple days with commas (`,`) |
| BackupRetentionPeriod | string | no | The number of days to retain backups |

### Creates a database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/create-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| DBName | string | yes | The name of the database. The name must meet the following requirements: Consist of lowercase letters, digits, underscores (_), and… |
| Comment | string | no | The description of the database |

### To create a ClickHouse Enterprise Edition cluster, call the `CreateDBInstance` API
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/create-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClientToken | string | no | A client-provided token to ensure request idempotence. It must be unique across requests, contain only ASCII characters, and not exceed 64… |
| RegionId | string | yes | The region ID |
| ZoneId | string | no | The zone ID |
| VpcId | string | no | The VPC ID |
| VswitchId | string | no | The vSwitch ID |
| DBInstanceDescription | string | no | The description of the instance |
| EngineVersion | string | no | The engine version |
| ScaleMin | string | no | This parameter is deprecated. Use the `NodeCount`, `NodeScaleMin`, and `NodeScaleMax` parameters to configure elastic scaling |
| ScaleMax | string | no | This parameter is deprecated. Use the `NodeCount`, `NodeScaleMin`, and `NodeScaleMax` parameters to configure elastic scaling |
| Engine | string | no | The engine type |
| MultiZone | string | no | The multi-zone configuration (JSON-encoded) |
| DeploySchema | string | no | The deployment mode of the instance |
| SourceDBInstanceId | string | no | The ID of the source instance. This parameter is required when restoring from a backup |
| BackupSetId | string | no | The backup set ID |
| ResourceGroupId | string | no | The ID of the resource group to which the instance belongs |
| NodeScaleMax | integer | no | The maximum number of nodes for serverless elastic scaling. Valid values: 4 to 32. The value must be greater than the `NodeScaleMin`… |
| NodeScaleMin | integer | no | The minimum number of nodes for serverless elastic scaling. Valid values: 4 to 32 |
| NodeCount | integer | no | The number of nodes. Valid values: 2 to 16. This parameter is required when you configure an elastic scaling range by using the… |
| StorageQuota | integer | no | 存储预购量（GB） |
| StorageType | string | no | 存储类型 |
| DBTimeZone | string | no | The time zone of the database, which must be an IANA time zone identifier |
| Category | string | no | The edition of the instance. Valid value: `enterprise`: Enterprise Edition |
| Tags | string | no | The tags to add to the instance (JSON-encoded) |

### Allocates a public endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/create-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| DBInstanceNetType | string | no | The network type |
| ConnectionPrefix | string | no | The prefix of the destination endpoint. This is the prefix of the ConnectionString parameter |
| ComputingGroupId | string | no | The compute group ID |

### Creates a Langfuse organization
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/create-langfuse-org` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| Name | string | yes | The name of the Langfuse organization |
| OwnerEmail | string | yes | The email address of the Langfuse organization owner |

### Adds a user to a Langfuse organization
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/create-langfuse-org-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| OrganizationId | string | yes | The Langfuse organization ID |
| Email | string | yes | The email address of the user |
| Role | string | yes | The role of the user in the organization |

### Creates a Langfuse project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/create-langfuse-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| OrganizationId | string | yes | The ID of the organization to which the Langfuse project belongs |
| Name | string | yes | The name of the Langfuse project |

### Creates a Langfuse user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/create-langfuse-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| Email | string | yes | The email address of the user |
| Name | string | yes | The name of the user |
| Password | string | yes | The password of the user account. The password must meet the following requirements: It must contain at least three of the following… |
| OrganizationId | string | no | The ID of the Langfuse organization |
| OrgRole | string | no | The role of the user in the organization |

### Creates a whitelist template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/create-whitelist-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| TemplateName | string | yes | The name of the whitelist template |
| SecurityIPList | string | yes | The IP addresses in the whitelist. Separate multiple IP addresses with commas (,). You can add up to 100 IP addresses |

### Deletes a database account from an ApsaraDB for ClickHouse cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/delete-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID |
| Account | string | yes | The destination database account |
| RegionId | string | yes | The region ID |
| Product | string | no | The code of the cloud service |

### Deletes the backup policy for a ClickHouse Enterprise Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/delete-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID |
| RegionId | string | yes | The region ID |

### Call this operation to delete a database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/delete-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| DBName | string | yes | The name of the target database |

### Calls the DeleteDBInstance operation to release an ApsaraDB for ClickHouse Enterprise Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/delete-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The ID of the target cluster |

### Releases a public endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/delete-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The ID of the cluster |
| ConnectionString | string | no | The prefix of the endpoint to be released, which is the prefix part of the ConnectionString parameter |
| DBInstanceNetType | string | no | The network type. Valid values: Vpc: VPC network. Public: public network |
| ComputingGroupId | string | no | The compute group ID |

### Releases a Langfuse instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/delete-langfuse-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| ConfirmDeleteAiGateway | string | no | The confirmation flag for deleting the AiGateway instance associated with the Langfuse instance |

### Deletes a Langfuse organization
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/delete-langfuse-org` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| OrganizationId | string | yes | The Langfuse organization ID |

### Removes a user from a Langfuse organization
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/delete-langfuse-org-membership` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| OrganizationId | string | yes | The Langfuse organization ID |
| Email | string | yes | The email address of the user |

### Deletes a Langfuse project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/delete-langfuse-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| OrganizationId | string | yes | The Langfuse organization ID |
| ProjectId | string | yes | The Langfuse project ID |

### Deletes a Langfuse user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/delete-langfuse-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| Email | string | yes | The email address of the user |

### Deletes a whitelist template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/delete-whitelist-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| TemplateId | string | yes | The whitelist template ID |
| TemplateName | string | no | The name of the whitelist template |

### Call the DescribeAccountAuthority operation to query the permissions of an account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-account-authority` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| Account | string | yes | The name of the database account |

### Queries the list of database accounts for a specified ApsaraDB for ClickHouse cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page. Valid values: 30 (default) 50 100 |
| Product | string | no | The product code |

### Queries the backup policy of a ClickHouse Enterprise Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID |
| RegionId | string | yes | The region ID |

### Queries the backup sets of an ApsaraDB for ClickHouse Enterprise Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-backups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/170875.html operation to query the region ID |
| BackupId | string | no | The backup record ID |
| StartTime | string | yes | The start time of the backup in UTC |
| EndTime | string | yes | The end time of the backup in UTC |
| PageSize | integer | no | The number of entries per page |
| PageNumber | integer | no | The page number |

### Queries the details of an ApsaraDB for ClickHouse cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-dbinstance-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID |
| RegionId | string | yes | The region ID |

### Queries the parameter configuration of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-dbinstance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID |

### Queries the parameter settings change records of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-dbinstance-config-change-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID |
| StartTime | string | yes | The beginning of the time range to query. Format: yyyy-MM-dd hh:mm:ss |
| EndTime | string | yes | The end of the time range to query. Format: yyyy-MM-dd hh:mm:ss |
| PageSize | integer | no | The number of entries per page. Valid values: 30 (default) 50 100 |
| PageNumber | integer | no | The page number |

### Queries the data structure of a database or table by calling the DescribeDBInstanceDataSources operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-dbinstance-data-sources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| DBName | string | no | The database name |
| TableName | string | no | The table name |

### Queries a list of clusters
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-dbinstances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceIds | string | no | The list of cluster IDs. Separate multiple cluster IDs with commas (,) |
| VpcIds | string | no | The list of VPC IDs |
| DBInstanceStatus | string | no | The cluster status |
| Description | string | no | The cluster description |
| PageSize | integer | no | The number of entries per page |
| PageNumber | integer | no | The page number |
| ResourceGroupId | string | no | The resource group ID |
| Tags | string | no | The tag information (JSON-encoded) |

### Calls the DescribeEndpoints operation to query the endpoints of a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| ComputingGroupId | string | no | The compute group ID |

### Queries the access endpoint of a Langfuse instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-langfuse-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |

### Queries the members of a Langfuse organization
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-langfuse-org-memberships` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| OrganizationId | string | yes | The ID of the Langfuse organization |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |

### Queries the organizations of a Langfuse instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-langfuse-orgs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The instance ID of the Langfuse instance |
| PageSize | integer | no | The number of entries per page |
| PageNumber | integer | no | The page number |

### Queries user roles in a Langfuse project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-langfuse-project-memberships` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| OrganizationId | string | yes | The Langfuse organization ID |
| ProjectId | string | yes | The Langfuse project ID |
| PageSize | integer | no | The number of entries per page |
| PageNumber | integer | no | The page number |

### Queries the list of Langfuse projects
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-langfuse-projects` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| OrganizationId | string | yes | The Langfuse organization ID |

### Queries the Langfuse whitelist
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-langfuse-security-iplist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |

### Queries the details of a Langfuse user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-langfuse-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| Email | string | yes | The email address of the user |

### Queries the list of Langfuse users
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-langfuse-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| Email | string | no | The email address of the user |
| Name | string | no | The username |
| PageSize | integer | no | The number of entries to return on each page |
| PageNumber | integer | no | The current page number |

### Calls the DescribeProcessList operation to view queries that are currently running
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-process-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| QueryDurationMs | string | no | The execution duration of slow SQL statements. Unit: ms. Minimum value: 1000 ms |
| InitialUser | string | no | The query user |
| Keyword | string | no | The keyword of the query statement |
| InitialQueryId | string | no | The query ID |
| QueryOrder | integer | no | Sorts results in descending order by the specified columns. 0: Sorts only by query_duration_ms. 1: Sorts by query_duration_ms and… |
| PageSize | integer | no | The number of entries per page |
| PageNumber | integer | no | The page number |
| ComputingGroupId | string | no | The compute group ID |

### Returns information about the available regions and zones for ApsaraDB for ClickHouse
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-regions` (byok)

### Queries the IP address whitelist of a cluster by calling the DescribeSecurityIPList operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-security-iplist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |

### Queries slow query log details by calling the DescribeSlowLogRecords operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-slow-log-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| StartTime | string | no | The beginning of the time range to query. Format: yyyy-MM-dd hh:mm:ss (UTC) |
| EndTime | string | no | The end of the time range to query. Format: yyyy-MM-dd hh:mm:ss (UTC) |
| QueryDurationMs | string | no | The execution duration of the slow SQL statement. The minimum value is 1000. Unit: milliseconds |
| PageSize | integer | no | The number of entries per page. Valid values: 30 (default) 50 100 |
| PageNumber | integer | no | The page number |
| ComputingGroupId | string | no | The compute group ID |

### Queries slow log trends by calling the DescribeSlowLogTrend operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/describe-slow-log-trend` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| StartTime | string | no | The start time of the query. Format: yyyy-MM-dd hh:mm:ss (UTC) |
| EndTime | string | no | The end time of the query. Format: yyyy-MM-dd hh:mm:ss (UTC) |
| QueryDurationMs | string | no | The execution duration of slow SQL statements. The minimum value is 1000. Unit: milliseconds |
| Product | string | no | The product code |
| ComputingGroupId | string | no | The compute group ID |

### Disassociate a whitelist template from an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/detach-whitelist-template-to-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| TemplateId | string | yes | The whitelist template ID |
| DBInstanceId | string | yes | The IDs of the ClickHouse instances, separated by commas. You can specify up to 20 IDs |

### Queries the details of a whitelist template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/get-whitelist-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| TemplateId | string | yes | The ID of the whitelist template |

### Stops an ongoing task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/kill-process` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| InitialQueryId | string | no | The query ID |
| ComputingGroupId | string | no | The compute group ID |

### Lists the available time zones for ClickHouse
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/list-click-house-dbtimezones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PageSize | integer | no | The number of records on each page. Valid values: 30 (default) 50 100 |
| PageNumber | integer | no | The page number |

### Lists the IP address whitelist templates linked to an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/list-instance-linked-whitelist-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The instance ID |

### Queries the whitelist templates associated with an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/list-whitelist-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| TemplateName | string | no | The whitelist template name. Fuzzy search is supported |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |

### Modifies the authorization information of an account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/modify-account-authority` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| Account | string | yes | The database account |
| DmlAuthSetting | string | yes | The authorization information (JSON-encoded) |

### Modifies the description of a database account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/modify-account-description` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| Account | string | yes | The name of the account |
| Description | string | yes | The description of the account |

### Modifies the backup policy of an ApsaraDB for ClickHouse Enterprise Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/modify-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID |
| RegionId | string | yes | The region ID |
| PreferredBackupTime | string | yes | The backup time in UTC. The format is HH:mmZ-HH:mmZ |
| PreferredBackupPeriod | string | yes | The backup cycle |
| BackupRetentionPeriod | string | no | The number of days for which backups are retained |

### Modifies the configuration attributes of a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/modify-dbinstance-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| AttributeType | string | yes | The attribute type to modify. MaintainTime: Modifies the O&M window. DBInstanceDescription: Modifies the instance name |
| AttributeValue | string | yes | The new value of the attribute |
| Product | string | no | The product code |

### Modifies the elastic configuration of a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/modify-dbinstance-class` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| ScaleMin | integer | no | [Deprecated] The minimum value for serverless elastic scaling |
| ScaleMax | integer | no | [Deprecated] The maximum value for serverless elastic scaling |
| NodeScaleMax | integer | no | The maximum value for serverless node elastic scaling. Valid values: 4 to 32. The value must be greater than the minimum value |
| NodeScaleMin | integer | no | The minimum value for serverless node elastic scaling. Valid values: 4 to 32 |
| NodeCount | integer | no | The number of nodes. Valid values: 2 to 16 |
| StorageQuota | integer | no | The purchased storage quota. Unit: GB |
| StorageType | string | no | The storage type |
| ComputingGroupId | string | no | The compute group ID |
| AutoScaleConfig | string | no | The automatic horizontal elastic configuration (JSON-encoded) |

### Modifies the parameter settings for a DB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/modify-dbinstance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID |
| Parameters | string | no | The API data parameter settings in JSON format |

### Calls the ModifyDBInstanceConnectionString operation to modify the endpoint of a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/modify-dbinstance-connection-string` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| ConnectionString | string | no | The endpoint |
| ConnectionStringPrefix | string | no | The prefix of the database endpoint |
| DisablePorts | string | no | Disables specified database ports. You can specify multiple ports separated by commas (,). Only clusters with a kernel version of… |
| DBInstanceNetType | string | no | The network type. Valid values: Vpc: VPC network. Public: public network |
| ComputingGroupId | string | no | The compute group ID |

### Modifies the permissions of a user in a Langfuse organization
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/modify-langfuse-org-membership` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| OrganizationId | string | yes | The Langfuse organization ID |
| Email | string | yes | The email address of the user |
| Role | string | yes | The role of the user in the organization |

### Modifies the permissions of a user in a Langfuse project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/modify-langfuse-project-membership` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| OrganizationId | string | yes | The Langfuse organization ID |
| ProjectId | string | yes | The Langfuse project ID |
| Email | string | yes | The email address of the user |
| Role | string | yes | The role of the user in the project |

### Modifies the whitelist of a Langfuse instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/modify-langfuse-security-iplist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| GroupName | string | no | The name of the whitelist group |
| SecurityIPList | string | no | The IP addresses to add to the instance whitelist. Separate multiple IP addresses with commas (,). For example, 192.168.0.0/24 indicates… |
| ModifyMode | string | no | The modification mode. Valid values: 0: overwrite 1: increase 2: delete Specify 0 to use the overwrite mode |

### Modifies the whitelist settings of a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/modify-security-iplist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |
| GroupName | string | no | The name of the group to modify |
| SecurityIPList | string | no | The whitelisted IP addresses |
| ModifyMode | string | no | The modification mode. Valid values: 0: overwrites the existing whitelist. 1: adds IP addresses to the whitelist. 2: removes IP addresses… |

### Resets the password of a database account for an ApsaraDB for ClickHouse Enterprise Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/reset-account-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID |
| RegionId | string | yes | The region ID |
| Account | string | yes | The name of the database account |
| Password | string | yes | The password of the database account. The password must meet the following requirements: The password must contain at least three of the… |
| Product | string | no | The service name |

### Resets the password of a Langfuse user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/reset-langfuse-user-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The Langfuse instance ID |
| Email | string | yes | The email address of the user |
| NewPassword | string | yes | The new user password. The password must meet the following rules: The password must contain at least three of the following character… |

### Restarts an ApsaraDB for ClickHouse cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/restart-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |

### Calls the StartDBInstance operation to start an ApsaraDB for ClickHouse Enterprise Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/start-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |

### Calls the StopDBInstance operation to pause an ApsaraDB for ClickHouse Enterprise Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/stop-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The cluster ID |

### Updates a whitelist template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/update-whitelist-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| TemplateId | string | yes | The whitelist template ID |
| TemplateName | string | yes | The whitelist template name |
| SecurityIPList | string | yes | The IP address whitelist. You can add up to 100 IP addresses, separated by commas |

### Upgrades the minor engine version of a specified ApsaraDB for ClickHouse Enterprise Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/upgrade-minor-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID |
| SwitchTimeMode | string | no | Specifies whether to upgrade the minor engine version immediately. Valid values: Immediate: Upgrades immediately. MaintainTime: Upgrades… |
| SwitchTime | string | no | The specified upgrade time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC). If SwitchTimeMode is set to SpecifyTime, you must use this parameter to… |
| TargetMinorVersion | string | no | The target minor engine version. By default, this parameter is left empty, and the minor engine version is upgraded to the latest version |
| RegionId | string | yes | The region ID |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/version` (byok)

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/attach-whitelist-template-to-instance" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud ApsaraDB for ClickHouse API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-clickhouse/attach-whitelist-template-to-instance with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud ApsaraDB for ClickHouse API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud ApsaraDB for ClickHouse itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud ApsaraDB for ClickHouse API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-clickhouse.

### What is the status of the Alibaba Cloud ApsaraDB for ClickHouse API?
Needs your own provider key (bring your own key)