Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

Get service autoscaling schedule

Beta
View as MarkdownEdit this pageReport an issueSet up docs MCP
GET/v1/organizations/{organizationId}/services/{serviceId}/scalingSchedule

Disclaimer: This beta endpoint is evolving; the API contract may change.

Returns the autoscaling schedule for a service. Returns 404 if no schedule has been configured or if the schedule was cleared. Requires the scheduled autoscaling feature to be enabled for the organization.

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the organization that owns the service.

    format: uuid
  • serviceIdstringrequired

    ID of the service.

    format: uuid

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalobject
    3 properties
    • entriesarray ofobjectrequired

      List of schedule entries.

      13 properties
      • idstringrequired

        Unique identifier for this schedule entry.

        format: uuid
      • namestringrequired

        Human-readable label for this schedule entry.

      • weekdaysarray ofintegerrequired

        Days of the week this entry applies to. 0 = Sunday, 1 = Monday, …, 6 = Saturday.

      • startHourUtcintegerrequired

        UTC hour (0–23) when this entry becomes active (inclusive).

        maximum: 23, minimum: 0
      • endHourUtcintegerrequired

        UTC hour (1–24) when this entry deactivates (exclusive). Must differ from startHourUtc. Set to 24 to end at midnight. Values less than startHourUtc create an overnight window spanning midnight.

        maximum: 24, minimum: 1
      • autoscalingModeverticalorhorizontalrequired

        Autoscaling mode for this entry. "vertical" runs a fixed replica count while memory scales; "horizontal" scales the replica count at a fixed per-replica memory. Defaults to "vertical" for entries persisted before the mode was exposed.

      • isActiveNowbooleanrequired

        Whether this entry is currently active. Scheduled times are indicative — actions are applied on a best-effort basis and may be delayed by a few minutes.

      • minReplicaMemoryGboptionalnumber

        Minimum memory per replica (Gb) during this window. A range in vertical; in horizontal it equals maxReplicaMemoryGb (memory is fixed while the replica count scales).

      • maxReplicaMemoryGboptionalnumber

        Maximum memory per replica (Gb) during this window. A range in vertical; in horizontal it equals minReplicaMemoryGb (memory is fixed while the replica count scales).

      • minReplicasoptionalinteger

        Minimum number of replicas during this window. For a horizontal entry the replica count scales between minReplicas and maxReplicas; for a vertical entry minReplicas and maxReplicas are equal and report the fixed replica count (both omitted when the entry stored no count).

      • maxReplicasoptionalinteger

        Maximum number of replicas during this window. For a horizontal entry the replica count scales between minReplicas and maxReplicas; for a vertical entry minReplicas and maxReplicas are equal and report the fixed replica count (both omitted when the entry stored no count).

      • idleScalingoptionalboolean

        Whether idle scaling is enabled during this window.

      • idleTimeoutMinutesoptionalinteger

        Idle timeout in minutes during this window.

    • baseConfigobjectrequired
      7 properties
      • autoscalingModeoptionalverticalorhorizontal

        Autoscaling mode applied when no schedule entry is active. "vertical" runs a fixed replica count while memory scales; "horizontal" scales the replica count at a fixed per-replica memory.

      • minReplicaMemoryGboptionalnumber

        Minimum memory per replica (Gb) when no schedule entry is active. Absent for services that do not autoscale memory.

      • maxReplicaMemoryGboptionalnumber

        Maximum memory per replica (Gb) when no schedule entry is active. Absent for services that do not autoscale memory.

      • minReplicasoptionalinteger

        Minimum number of replicas when no schedule entry is active.

      • maxReplicasoptionalinteger

        Maximum number of replicas when no schedule entry is active.

      • idleScalingoptionalboolean

        Whether idle scaling is enabled when no schedule entry is active.

      • idleTimeoutMinutesoptionalinteger

        Idle timeout in minutes when no schedule entry is active.

    • activeEntryIdoptionalstring

      ID of the currently-active schedule entry. Absent when no entry is active and the base config is in effect.

      format: uuid
Navigation