Create or replace service autoscaling schedule

Creates or fully replaces the autoscaling schedule for a service. Pass an empty entries array to clear the schedule — a subsequent GET will return 404, and the response will contain an empty baseConfig (all fields absent). The base scaling config (applied when no entry is active) is managed separately via the replicaScaling endpoint. Requires the scheduled autoscaling feature to be enabled for the organization.

POST /v1/organizations/{organizationId}/services/{serviceId}/scalingSchedule

Create or replace service autoscaling schedule

cURL

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/scalingSchedule \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entries": [
    {
      "name": "Business hours",
      "weekdays": [
        1,
        2,
        3,
        4,
        5
      ],
      "startHourUtc": 9,
      "endHourUtc": 17,
      "autoscalingMode": "vertical",
      "minReplicaMemoryGb": 16,
      "maxReplicaMemoryGb": 16,
      "numReplicas": 3,
      "minReplicas": 2,
      "maxReplicas": 3,
      "idleScaling": true,
      "idleTimeoutMinutes": 123
    }
  ]
}
'

200

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "entries": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "weekdays": [
          123
        ],
        "startHourUtc": 11,
        "endHourUtc": 12,
        "autoscalingMode": "vertical",
        "isActiveNow": true,
        "minReplicaMemoryGb": 123,
        "maxReplicaMemoryGb": 123,
        "minReplicas": 123,
        "maxReplicas": 123,
        "idleScaling": true,
        "idleTimeoutMinutes": 123
      }
    ],
    "baseConfig": {
      "autoscalingMode": "vertical",
      "minReplicaMemoryGb": 123,
      "maxReplicaMemoryGb": 123,
      "minReplicas": 123,
      "maxReplicas": 123,
      "idleScaling": true,
      "idleTimeoutMinutes": 123
    },
    "activeEntryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Creates or fully replaces the autoscaling schedule for a service. Pass an empty entries array to clear the schedule — a subsequent GET will return 404, and the response will contain an empty baseConfig (all fields absent). The base scaling config (applied when no entry is active) is managed separately via the replicaScaling endpoint. Requires the scheduled autoscaling feature to be enabled for the organization.

​

Permission

The API key must have the control-plane:service:manage-scaling-config permission.

التفويضات

Authorization · string · header · مطلوب

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

معلمات المسار

organizationId · string<uuid> · مطلوب

ID of the organization that owns the service.

serviceId · string<uuid> · مطلوب

ID of the service.

الجسم

application/json

entries · object[] · مطلوب

List of schedule entries. Pass an empty array to clear the schedule.

Show child attributes

الاستجابة

200

application/json

Successful response

status · number

HTTP status code.

مثال:

200

requestId · string<uuid>

Unique id assigned to every request. UUIDv4

result · object

Show child attributes