Update service auto scaling settings

Updates minimum and maximum memory limits per replica and idle mode scaling behavior for the service. The memory settings are available only for “production” services and must be a multiple of 4 starting from 8GB. Please contact support to enable adjustment of numReplicas.

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

Update service auto scaling settings

cURL

curl --request PATCH \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/replicaScaling \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "minReplicaMemoryGb": 16,
  "maxReplicaMemoryGb": 120,
  "numReplicas": 3,
  "idleScaling": true,
  "idleTimeoutMinutes": 123
}
'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/replicaScaling"

payload = {
    "minReplicaMemoryGb": 16,
    "maxReplicaMemoryGb": 120,
    "numReplicas": 3,
    "idleScaling": True,
    "idleTimeoutMinutes": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    minReplicaMemoryGb: 16,
    maxReplicaMemoryGb: 120,
    numReplicas: 3,
    idleScaling: true,
    idleTimeoutMinutes: 123
  })
};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/replicaScaling', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/replicaScaling",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'minReplicaMemoryGb' => 16,
    'maxReplicaMemoryGb' => 120,
    'numReplicas' => 3,
    'idleScaling' => true,
    'idleTimeoutMinutes' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/replicaScaling"

	payload := strings.NewReader("{\n  \"minReplicaMemoryGb\": 16,\n  \"maxReplicaMemoryGb\": 120,\n  \"numReplicas\": 3,\n  \"idleScaling\": true,\n  \"idleTimeoutMinutes\": 123\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/replicaScaling")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"minReplicaMemoryGb\": 16,\n  \"maxReplicaMemoryGb\": 120,\n  \"numReplicas\": 3,\n  \"idleScaling\": true,\n  \"idleTimeoutMinutes\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/replicaScaling")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"minReplicaMemoryGb\": 16,\n  \"maxReplicaMemoryGb\": 120,\n  \"numReplicas\": 3,\n  \"idleScaling\": true,\n  \"idleTimeoutMinutes\": 123\n}"

response = http.request(request)
puts response.read_body

200

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "clickhouseVersion": "<string>",
    "endpoints": [
      {
        "protocol": "mysql",
        "host": "<string>",
        "port": 123,
        "username": "<string>"
      }
    ],
    "minTotalMemoryGb": 48,
    "maxTotalMemoryGb": 360,
    "minReplicaMemoryGb": 16,
    "maxReplicaMemoryGb": 120,
    "numReplicas": 3,
    "idleScaling": true,
    "idleTimeoutMinutes": 123,
    "ipAccessList": [
      {
        "source": "<string>",
        "description": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "encryptionKey": "<string>",
    "encryptionAssumedRoleIdentifier": "<string>",
    "iamRole": "<string>",
    "privateEndpointIds": [
      "<string>"
    ],
    "availablePrivateEndpointIds": [
      "<string>"
    ],
    "dataWarehouseId": "<string>",
    "isPrimary": true,
    "isReadonly": true,
    "byocId": "<string>",
    "hasTransparentDataEncryption": true,
    "transparentDataEncryptionKeyId": "<string>",
    "encryptionRoleId": "<string>"
  }
}

{
  "status": 400,
  "error": "<string>"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

organizationId · string<uuid> · required

ID of the organization that owns the service.

serviceId · string<uuid> · required

ID of the service to update scaling parameters.

Body

application/json

minReplicaMemoryGb · number

Minimum auto-scaling memory in Gb for a single replica. Available only for 'production' services. Must be a multiple of 4 and greater than or equal to 8.

Required range: 8 <= x <= 356Must be a multiple of 4

Example:

16

maxReplicaMemoryGb · number

Maximum auto-scaling memory in Gb for a single replica . Available only for 'production' services. Must be a multiple of 4 and lower than or equal to 120 for non paid services or 356 for paid services.

Required range: 8 <= x <= 356Must be a multiple of 4

Example:

120

numReplicas · number

Number of replicas for the service. The number of replicas must be between 2 and 20 for the first service in a warehouse. Services that are created in an existing warehouse can have a number of replicas as low as 1. Further restrictions may apply based on your organization's tier. It defaults to 1 for the BASIC tier and 3 for the SCALE and ENTERPRISE tiers.

Required range: 1 <= x <= 20

Example:

3

idleScaling · boolean

When set to true the service is allowed to scale down to zero when idle. True by default.

idleTimeoutMinutes · number

Set minimum idling timeout (in minutes). Must be >= 5 minutes.

Response

200

application/json

Successful response

status · number

HTTP status code.

Example:

200

requestId · string<uuid>

Unique id assigned to every request. UUIDv4

result · object

Show child attributes