> ## 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 Instance Get: Inputs, Cost & CLI Example
> Get service details. Clickhouse Clickhouse Instance Get docs include request fields, response shape, pricing notes, and Deepline CLI examples.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=clickhouse_instance_get:{"organizationId":"{{organizationId}}","serviceId":"{{serviceId}}"}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ------------------------ | -------- | -------- | ------- | --------------------------------------------- |
| `payload.organizationId` | `string` | Yes | | ID of the organization that owns the service. |
| `payload.serviceId` | `string` | Yes | | ID of the requested service. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Returns a service that belongs to the organization",
"properties": {
"organizationId": {
"type": "string",
"description": "ID of the organization that owns the service.",
"format": "uuid"
},
"serviceId": {
"type": "string",
"description": "ID of the requested service.",
"format": "uuid"
}
},
"required": [
"organizationId",
"serviceId"
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes | | Provider response payload. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"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": {
"id": {
"type": "string",
"description": "Unique service ID.",
"format": "uuid"
},
"name": {
"type": "string",
"description": "Name of the service. Alphanumerical string with whitespaces up to 50 characters.",
"minLength": 1,
"maxLength": 50
},
"provider": {
"type": "string",
"description": "Cloud provider",
"enum": [
"aws",
"gcp",
"azure"
]
},
"region": {
"type": "string",
"description": "Service region.",
"enum": [
"ap-northeast-1",
"ap-northeast-2",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
"ca-central-1",
"eu-central-1",
"eu-west-1",
"eu-west-2",
"il-central-1",
"us-east-1",
"us-east-2",
"us-west-2",
"us-east1",
"us-central1",
"europe-west2",
"europe-west4",
"asia-southeast1",
"asia-northeast1",
"eastus",
"eastus2",
"westus3",
"germanywestcentral",
"centralus"
]
},
"state": {
"type": "string",
"description": "Current state of the service.",
"enum": [
"starting",
"stopping",
"terminating",
"softdeleting",
"awaking",
"partially_running",
"provisioning",
"running",
"stopped",
"terminated",
"softdeleted",
"degraded",
"failed",
"idle"
]
},
"clickhouseVersion": {
"type": "string",
"description": "ClickHouse version of the service."
},
"endpoints": {
"type": "array",
"description": "List of all service endpoints.",
"items": {
"properties": {
"protocol": {
"type": "string",
"description": "Endpoint protocol: 'https', 'nativesecure', 'mysql'.",
"enum": [
"https",
"nativesecure",
"mysql"
]
},
"host": {
"type": "string",
"description": "Service host name"
},
"port": {
"type": "number",
"description": "Numeric port"
},
"username": {
"type": [
"string",
"null"
],
"description": "Optional username for the endpoint"
}
},
"additionalProperties": false
}
},
"tier": {
"type": "string",
"description": "DEPRECATED for BASIC, SCALE and ENTERPRISE organization tiers. Use `minReplicaMemoryGb`, `maxReplicaMemoryGb`, and `numReplicas` instead. Tier of the service: 'development', 'production', 'dedicated_high_mem', 'dedicated_high_cpu', 'dedicated_standard', 'dedicated_standard_n2d_standard_4', 'dedicated_standard_n2d_standard_8', 'dedicated_standard_n2d_standard_32', 'dedicated_standard_n2d_standard_128', 'dedicated_standard_n2d_standard_32_16SSD', 'dedicated_standard_n2d_standard_64_24SSD'. Production services scale, Development are fixed size. Azure services don't support Development tier",
"enum": [
"development",
"production",
"dedicated_high_mem",
"dedicated_high_cpu",
"dedicated_standard",
"dedicated_standard_n2d_standard_4",
"dedicated_standard_n2d_standard_8",
"dedicated_standard_n2d_standard_32",
"dedicated_standard_n2d_standard_128",
"dedicated_standard_n2d_standard_32_16SSD",
"dedicated_standard_n2d_standard_64_24SSD"
]
},
"minTotalMemoryGb": {
"type": "number",
"description": "DEPRECATED - inaccurate for services with non-default numbers of replicas. Use `minReplicaMemoryGb` instead. Minimum memory of three workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than or equal to 24. Always absent for horizontal-autoscaling services (replica count is variable).",
"multipleOf": 12,
"minimum": 24,
"maximum": 1068
},
"maxTotalMemoryGb": {
"type": "number",
"description": "DEPRECATED - inaccurate for services with non-default numbers of replicas. Use `maxReplicaMemoryGb` instead. Maximum memory of three workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than or equal to 360 for non paid services or 1068 for paid services. Always absent for horizontal-autoscaling services (replica count is variable).",
"multipleOf": 12,
"minimum": 24,
"maximum": 1068
},
"minReplicaMemoryGb": {
"type": "number",
"description": "Minimum total memory of each replica during auto-scaling in Gb. A range in vertical autoscaling; equal to maxReplicaMemoryGb in horizontal (memory is fixed while the replica count scales). Must be a multiple of 4 and greater than or equal to 8.",
"multipleOf": 4,
"minimum": 8,
"maximum": 356
},
"maxReplicaMemoryGb": {
"type": "number",
"description": "Maximum total memory of each replica during auto-scaling in Gb. A range in vertical autoscaling; equal to minReplicaMemoryGb in horizontal (memory is fixed while the replica count scales). Must be a multiple of 4 and lower than or equal to 120* for non paid services or 356* for paid services.* - maximum replica size subject to cloud provider hardware availability in your selected region.",
"multipleOf": 4,
"minimum": 8,
"maximum": 356
},
"numReplicas": {
"type": "integer",
"description": "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. Present only when the service uses vertical autoscaling. For horizontal autoscaling, use minReplicas and maxReplicas instead.",
"minimum": 1,
"maximum": 20
},
"minReplicas": {
"type": "integer",
"description": "Minimum number of replicas for horizontal autoscaling. Present only when the service uses horizontal autoscaling.",
"minimum": 1,
"maximum": 20
},
"maxReplicas": {
"type": "integer",
"description": "Maximum number of replicas for horizontal autoscaling. Present only when the service uses horizontal autoscaling.",
"minimum": 1,
"maximum": 20
},
"autoscalingMode": {
"type": "string",
"description": "Configured autoscaling mode. \"vertical\" runs a fixed replica count while memory scales between minReplicaMemoryGb and maxReplicaMemoryGb; \"horizontal\" scales the replica count between minReplicas and maxReplicas at a fixed per-replica memory. This is the baseline configuration; the mode currently applied (which may differ while a schedule entry is active) is currentScaling.effectiveAutoscalingMode.",
"enum": [
"vertical",
"horizontal"
]
},
"replicaMemoryGb": {
"type": "number",
"description": "Fixed memory per replica in Gb for horizontal autoscaling. Present only when the service uses horizontal autoscaling. Must be a multiple of 4, at least 8 Gb, and at most 120 Gb for non paid services or 356 Gb for paid services.",
"multipleOf": 4,
"minimum": 8,
"maximum": 356
},
"idleScaling": {
"type": "boolean",
"description": "When set to true the service is allowed to scale down to zero when idle. True by default."
},
"idleTimeoutMinutes": {
"type": "number",
"description": "Set minimum idling timeout (in minutes). Must be >= 5 minutes."
},
"ipAccessList": {
"type": "array",
"description": "List of IP addresses allowed to access the service",
"items": {
"properties": {
"source": {
"type": "string",
"description": "IP or CIDR"
},
"description": {
"type": "string",
"description": "Optional description of IPv4 address or IPv4 CIDR to allow access from"
}
},
"additionalProperties": false
}
},
"createdAt": {
"type": "string",
"description": "Service creation timestamp. ISO-8601.",
"format": "date-time"
},
"encryptionKey": {
"type": "string",
"description": "Optional customer provided disk encryption key"
},
"encryptionAssumedRoleIdentifier": {
"type": "string",
"description": "Optional role to use for disk encryption"
},
"iamRole": {
"type": "string",
"description": "IAM role used for accessing objects in s3"
},
"privateEndpointIds": {
"type": "array",
"description": "List of private endpoints",
"items": {
"type": "string"
}
},
"availablePrivateEndpointIds": {
"type": "array",
"description": "List of available private endpoints ids that can be attached to the service",
"items": {
"type": "string"
}
},
"dataWarehouseId": {
"type": "string",
"description": "Data warehouse containing this service"
},
"isPrimary": {
"type": "boolean",
"description": "True if this service is the primary service in the data warehouse"
},
"isReadonly": {
"type": "boolean",
"description": "True if this service is read-only. It can only be read-only if a dataWarehouseId is provided."
},
"releaseChannel": {
"type": "string",
"description": "Select fast if you want to get new ClickHouse releases as soon as they are available. You'll get new features faster, but with a higher risk of bugs. Select slow if you would like to defer releases to give yourself more time to test. This feature is only available for production services. default is the regular release channel.",
"enum": [
"slow",
"default",
"fast"
]
},
"byocId": {
"type": "string",
"description": "This is the ID returned after setting up a region for Bring Your Own Cloud (BYOC). When the byocId parameter is specified, the minReplicaMemoryGb and the maxReplicaGb parameters are required too, with values included among the following sizes: 48, 116, 172, 232."
},
"hasTransparentDataEncryption": {
"type": "boolean",
"description": "True if the service should have the Transparent Data Encryption (TDE) enabled. TDE is only available for ENTERPRISE organizations tiers and can only be enabled at service creation."
},
"profile": {
"type": "string",
"description": "Custom instance profile. Only available for ENTERPRISE organization tiers.",
"enum": [
"v1-default",
"v1-highmem-xs",
"v1-highmem-s",
"v1-highmem-m",
"v1-highmem-l",
"v1-highmem-xl"
]
},
"transparentDataEncryptionKeyId": {
"type": "string",
"description": "The ID of the Transparent Data Encryption key used for the service. This is only available if hasTransparentDataEncryption is true."
},
"encryptionRoleId": {
"type": "string",
"description": "The ID of the IAM role used for encryption. This is only available if hasTransparentDataEncryption is true."
},
"complianceType": {
"type": "string",
"description": "Type of regulatory compliance for service.",
"enum": [
"hipaa",
"pci"
]
},
"tags": {
"type": "array",
"description": "Tags associated with the service.",
"maxItems": 50,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Tag key. Must be alphanumeric with dashes, underscores and dots.",
"minLength": 1,
"maxLength": 128,
"pattern": "^[a-zA-Z0-9._-]+$"
},
"value": {
"type": "string",
"description": "Tag value. Must be alphanumeric with dashes, underscores and dots.",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9._-]+$"
}
},
"required": [
"key"
],
"additionalProperties": false
}
},
"enableCoreDumps": {
"type": "boolean",
"description": "True if the service's underline infra is enabled for collecting core dumps. This is an experimental feature"
},
"scalingSchedule": {
"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
},
"currentScaling": {
"properties": {
"effectiveAutoscalingMode": {
"type": "string",
"description": "Autoscaling mode currently in effect on the running service. May diverge from the configured baseline mode while a schedule entry is active.",
"enum": [
"vertical",
"horizontal"
]
},
"effectiveMinReplicaMemoryGb": {
"type": "number",
"description": "Minimum memory per replica (Gb) currently applied to the running service. May diverge from the top-level `minReplicaMemoryGb` baseline while a schedule entry is active."
},
"effectiveMaxReplicaMemoryGb": {
"type": "number",
"description": "Maximum memory per replica (Gb) currently applied to the running service. May diverge from the top-level `maxReplicaMemoryGb` baseline while a schedule entry is active. Reflects the stored value: normally equal to `effectiveMinReplicaMemoryGb` in horizontal mode, but a legacy service stored with an unequal memory range reports the stored bounds as-is."
},
"effectiveMinReplicas": {
"type": "integer",
"description": "Minimum number of replicas currently applied to the running service. May diverge from the baseline while a schedule entry is active. Reflects the stored value: normally equal to `effectiveMaxReplicas` in vertical mode (a fixed replica count), but a legacy service stored with an unequal replica range reports the stored bounds as-is."
},
"effectiveMaxReplicas": {
"type": "integer",
"description": "Maximum number of replicas currently applied to the running service. May diverge from the baseline while a schedule entry is active."
},
"effectiveIdleScaling": {
"type": "boolean",
"description": "Whether idle scaling is currently in effect on the service. May diverge from the top-level `idleScaling` baseline while a schedule entry is active."
},
"effectiveIdleTimeoutMinutes": {
"type": "integer",
"description": "Idle timeout in minutes currently in effect on the service. May diverge from the top-level `idleTimeoutMinutes` baseline while a schedule entry is active."
},
"activeEntryId": {
"type": "string",
"description": "ID of the schedule entry whose values are currently applied to the service. Absent when no entry is active.",
"format": "uuid"
}
},
"additionalProperties": false
}
},
"required": [
"autoscalingMode",
"currentScaling"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute clickhouse_instance_get --payload '{
"organizationId": "string",
"serviceId": "string"
}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.