> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickHouse Cloud: Clickhouse Scaling Schedule Get

> Get the scheduled autoscaling entries of a ClickHouse Cloud service. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get the scheduled autoscaling entries of a ClickHouse Cloud service.

> [!NOTE]
>
> Tool ID: `clickhouse_scaling_schedule_get`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clickhouse_scaling_schedule_get',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "serviceId": "123e4567-e89b-42d3-a456-426614174000"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute clickhouse_scaling_schedule_get --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000"
  }
}
```

Use `deepline describe clickhouse_scaling_schedule_get --json` for the latest machine-readable contract.

## Input reference

**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.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.organizationId` | `string` | Yes | — | ID of the organization that owns the service. Format: `uuid`. |
| `payload.serviceId` | `string` | Yes | — | ID of the service. Format: `uuid`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "**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.",
    "properties": {
      "organizationId": {
        "type": "string",
        "description": "ID of the organization that owns the service.",
        "format": "uuid"
      },
      "serviceId": {
        "type": "string",
        "description": "ID of the service.",
        "format": "uuid"
      }
    },
    "required": [
      "organizationId",
      "serviceId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.status` | `number` | No | — | HTTP status code. |
| `result.data.requestId` | `string` | No | — | Unique id assigned to every request. UUIDv4 Format: `uuid`. |
| `result.data.result` | `object` | No | — | — |
| `result.data.result.entries` | `array` | Yes | — | List of schedule entries. |
| `result.data.result.entries[].id` | `string` | Yes | — | Unique identifier for this schedule entry. Format: `uuid`. |
| `result.data.result.entries[].name` | `string` | Yes | — | Human-readable label for this schedule entry. |
| `result.data.result.entries[].weekdays` | `array` | Yes | — | Days of the week this entry applies to. 0 = Sunday, 1 = Monday, …, 6 = Saturday. Minimum items: 1. |
| `result.data.result.entries[].startHourUtc` | `integer` | Yes | — | UTC hour (0–23) when this entry becomes active (inclusive). Minimum: 0. Maximum: 23. |
| `result.data.result.entries[].endHourUtc` | `integer` | Yes | — | 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. Minimum: 1. Maximum: 24. |
| `result.data.result.entries[].autoscalingMode` | `"vertical" \| "horizontal"` | Yes | — | 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. Allowed: `vertical`, `horizontal`. |
| `result.data.result.entries[].minReplicaMemoryGb` | `number` | No | — | 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). |
| `result.data.result.entries[].maxReplicaMemoryGb` | `number` | No | — | 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). |
| `result.data.result.entries[].minReplicas` | `integer` | No | — | 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). |
| `result.data.result.entries[].maxReplicas` | `integer` | No | — | 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). |
| `result.data.result.entries[].idleScaling` | `boolean` | No | — | Whether idle scaling is enabled during this window. |
| `result.data.result.entries[].idleTimeoutMinutes` | `integer` | No | — | Idle timeout in minutes during this window. |
| `result.data.result.entries[].isActiveNow` | `boolean` | Yes | — | 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. |
| `result.data.result.baseConfig` | `object` | Yes | — | — |
| `result.data.result.baseConfig.autoscalingMode` | `"vertical" \| "horizontal"` | No | — | 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. Allowed: `vertical`, `horizontal`. |
| `result.data.result.baseConfig.minReplicaMemoryGb` | `number` | No | — | Minimum memory per replica (Gb) when no schedule entry is active. |
| `result.data.result.baseConfig.maxReplicaMemoryGb` | `number` | No | — | Maximum memory per replica (Gb) when no schedule entry is active. |
| `result.data.result.baseConfig.minReplicas` | `integer` | No | — | Minimum number of replicas when no schedule entry is active. |
| `result.data.result.baseConfig.maxReplicas` | `integer` | No | — | Maximum number of replicas when no schedule entry is active. |
| `result.data.result.baseConfig.idleScaling` | `boolean` | No | — | Whether idle scaling is enabled when no schedule entry is active. |
| `result.data.result.baseConfig.idleTimeoutMinutes` | `integer` | No | — | Idle timeout in minutes when no schedule entry is active. |
| `result.data.result.activeEntryId` | `string` | No | — | ID of the currently-active schedule entry. Absent when no entry is active and the base config is in effect. Format: `uuid`. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "status": {
            "type": "number",
            "description": "HTTP status code."
          },
          "requestId": {
            "type": "string",
            "description": "Unique id assigned to every request. UUIDv4",
            "format": "uuid"
          },
          "result": {
            "properties": {
              "entries": {
                "type": "array",
                "description": "List of schedule entries.",
                "items": {
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique identifier for this schedule entry.",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "description": "Human-readable label for this schedule entry."
                    },
                    "weekdays": {
                      "type": "array",
                      "description": "Days of the week this entry applies to. 0 = Sunday, 1 = Monday, …, 6 = Saturday.",
                      "minItems": 1,
                      "items": {
                        "type": "integer"
                      }
                    },
                    "startHourUtc": {
                      "type": "integer",
                      "description": "UTC hour (0–23) when this entry becomes active (inclusive).",
                      "minimum": 0,
                      "maximum": 23
                    },
                    "endHourUtc": {
                      "type": "integer",
                      "description": "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.",
                      "minimum": 1,
                      "maximum": 24
                    },
                    "autoscalingMode": {
                      "type": "string",
                      "description": "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.",
                      "enum": [
                        "vertical",
                        "horizontal"
                      ]
                    },
                    "minReplicaMemoryGb": {
                      "type": "number",
                      "description": "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)."
                    },
                    "maxReplicaMemoryGb": {
                      "type": "number",
                      "description": "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)."
                    },
                    "minReplicas": {
                      "type": "integer",
                      "description": "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)."
                    },
                    "maxReplicas": {
                      "type": "integer",
                      "description": "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)."
                    },
                    "idleScaling": {
                      "type": "boolean",
                      "description": "Whether idle scaling is enabled during this window."
                    },
                    "idleTimeoutMinutes": {
                      "type": "integer",
                      "description": "Idle timeout in minutes during this window."
                    },
                    "isActiveNow": {
                      "type": "boolean",
                      "description": "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."
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "weekdays",
                    "startHourUtc",
                    "endHourUtc",
                    "autoscalingMode",
                    "isActiveNow"
                  ],
                  "additionalProperties": false
                }
              },
              "baseConfig": {
                "properties": {
                  "autoscalingMode": {
                    "type": "string",
                    "description": "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.",
                    "enum": [
                      "vertical",
                      "horizontal"
                    ]
                  },
                  "minReplicaMemoryGb": {
                    "type": "number",
                    "description": "Minimum memory per replica (Gb) when no schedule entry is active."
                  },
                  "maxReplicaMemoryGb": {
                    "type": "number",
                    "description": "Maximum memory per replica (Gb) when no schedule entry is active."
                  },
                  "minReplicas": {
                    "type": "integer",
                    "description": "Minimum number of replicas when no schedule entry is active."
                  },
                  "maxReplicas": {
                    "type": "integer",
                    "description": "Maximum number of replicas when no schedule entry is active."
                  },
                  "idleScaling": {
                    "type": "boolean",
                    "description": "Whether idle scaling is enabled when no schedule entry is active."
                  },
                  "idleTimeoutMinutes": {
                    "type": "integer",
                    "description": "Idle timeout in minutes when no schedule entry is active."
                  }
                },
                "additionalProperties": false
              },
              "activeEntryId": {
                "type": "string",
                "description": "ID of the currently-active schedule entry. Absent when no entry is active and the base config is in effect.",
                "format": "uuid"
              }
            },
            "required": [
              "entries",
              "baseConfig"
            ],
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [ClickHouse Cloud provider guide](https://deepline.com/docs/providers/clickhouse/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.