ClickPipes

Update CDC ClickPipes scaling

Update scaling settings for database ClickPipes (PostgreSQL, MySQL, MongoDB, BigQuery).

The infrastructure is shared between all database ClickPipes in the service, both for initial load and CDC. Scaling settings may take a few minutes to fully propagate.

For billing purposes, 2 CPU cores and 8 GB of RAM correspond to one compute unit. If your organization tier changes, database ClickPipes will be rescaled appropriately.

Note: For Kafka, Kinesis, and object storage pipes (S3, GCS, Azure Blob), see Get ClickPipe.

This endpoint becomes available once at least one database ClickPipe was provisioned.

patch/v1/organizations/{organizationId}/services/{serviceId}/clickpipesCdcScaling

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipesCdcScaling
  • Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the organization that owns the service.

serviceIdstring uuid required

ID of the service that owns the ClickPipe.

Request body

replicaCpuMillicoresinteger

CPU in millicores for DB ClickPipes.

replicaMemoryGbnumber

Memory in GiB for DB ClickPipes. Must be 4× the CPU core count.

Example request

{
  "replicaCpuMillicores": 2000,
  "replicaMemoryGb": 8
}

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

Example response

{
  "status": 200,
  "result": {
    "replicaCpuMillicores": 2000,
    "replicaMemoryGb": 8
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.