Update CDC ClickPipes scaling

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

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.

Authorizations

Authorizationstringheaderrequired
Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path parameters

organizationIdstringrequired
ID of the organization that owns the service.

format: uuid
serviceIdstringrequired
ID of the service that owns the ClickPipe.

format: uuid

Request bodyJSON

replicaCpuMillicoresoptionalinteger
CPU in millicores for DB ClickPipes.

maximum: 32000, minimum: 1000
Example: 2000
replicaMemoryGboptionalnumber
Memory in GiB for DB ClickPipes. Must be 4× the CPU core count.

maximum: 128, minimum: 4
Example: 8

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalobject
2 properties
- replicaCpuMillicoresoptionalinteger
  CPU in millicores for DB ClickPipes.
  
  maximum: 32000, minimum: 1000
  Example: 2000
- replicaMemoryGboptionalnumber
  Memory in GiB for DB ClickPipes. Must be 4× the CPU core count.
  
  maximum: 128, minimum: 4
  Example: 8

Update CDC ClickPipes scaling

curl --request PATCH \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickpipesCdcScaling \
  --header 'Authorization: Basic <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "replicaCpuMillicores": 2000,
  "replicaMemoryGb": 8
}
'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickpipesCdcScaling';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json', Authorization: 'Basic <token>'},
  body: JSON.stringify({replicaCpuMillicores: 2000, replicaMemoryGb: 8})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickpipesCdcScaling"

payload = {
    "replicaCpuMillicores": 2000,
    "replicaMemoryGb": 8
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Basic <token>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "replicaCpuMillicores": 2000,
    "replicaMemoryGb": 8
  }
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}