Tool ID:
clickhouse_instance_updateRun this action
Use the TypeScript SDK for one call. Usectx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'clickhouse_instance_update',
{
"organizationId": "123e4567-e89b-42d3-a456-426614174000",
"serviceId": "123e4567-e89b-42d3-a456-426614174000"
},
);
console.log(result.toolResponse.raw);
CLI
deepline tools execute clickhouse_instance_update --input '{
"organizationId": "123e4567-e89b-42d3-a456-426614174000",
"serviceId": "123e4567-e89b-42d3-a456-426614174000"
}' --json
Example response
The SDK returns this shape atresult.toolResponse.raw. The example values illustrate the response.
{
"data": {
"status": 123,
"requestId": "123e4567-e89b-42d3-a456-426614174000",
"result": {
"autoscalingMode": "vertical",
"currentScaling": {
"effectiveAutoscalingMode": "vertical",
"effectiveMinReplicaMemoryGb": 123,
"effectiveMaxReplicaMemoryGb": 123
}
}
}
}
deepline describe clickhouse_instance_update --json for the latest machine-readable contract.
Input reference
Updates basic service details like service name or IP access list.| 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 to update. Format: uuid. |
payload.name | string | No | — | Name of the service. Alphanumerical string with whitespaces up to 50 characters. Minimum length: 1. Maximum length: 50. |
payload.ipAccessList | object | No | — | — |
payload.privateEndpointIds | object | No | — | — |
payload.releaseChannel | "slow" | "default" | "fast" | No | — | 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. Allowed: slow, default, fast. |
payload.endpoints | array | No | — | List of service endpoints to change |
payload.transparentDataEncryptionKeyId | string | No | — | The id of the key to rotate |
payload.tags | object | No | — | — |
payload.enableCoreDumps | boolean | No | — | If true, the underlying infra is enabled for collecting core dumps. |
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.id | string | No | — | Unique service ID. Format: uuid. |
result.data.result.name | string | No | — | Name of the service. Alphanumerical string with whitespaces up to 50 characters. Minimum length: 1. Maximum length: 50. |
result.data.result.provider | "aws" | "gcp" | "azure" | No | — | Cloud provider Allowed: aws, gcp, azure. |
result.data.result.region | "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" | No | — | Service region. Allowed: 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. |
result.data.result.state | "starting" | "stopping" | "terminating" | "softdeleting" | "awaking" | "partially_running" | "provisioning" | "running" | "stopped" | "terminated" | "softdeleted" | "degraded" | "failed" | "idle" | No | — | Current state of the service. Allowed: starting, stopping, terminating, softdeleting, awaking, partially_running, provisioning, running, stopped, terminated, softdeleted, degraded, failed, idle. |
result.data.result.clickhouseVersion | string | No | — | ClickHouse version of the service. |
result.data.result.endpoints | array | No | — | List of all service endpoints. |
result.data.result.endpoints[].protocol | "https" | "nativesecure" | "mysql" | No | — | Endpoint protocol: ‘https’, ‘nativesecure’, ‘mysql’. Allowed: https, nativesecure, mysql. |
result.data.result.endpoints[].host | string | No | — | Service host name |
result.data.result.endpoints[].port | number | No | — | Numeric port |
result.data.result.endpoints[].username | string | null | No | — | Optional username for the endpoint |
result.data.result.tier | "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" | No | — | 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’. See the live schema for the complete constraint. |
result.data.result.minTotalMemoryGb | number | No | — | 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). Minimum: 24. Maximum: 1068. |
result.data.result.maxTotalMemoryGb | number | No | — | 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). Minimum: 24. Maximum: 1068. |
result.data.result.minReplicaMemoryGb | number | No | — | 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. Minimum: 8. Maximum: 356. |
result.data.result.maxReplicaMemoryGb | number | No | — | 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. Minimum: 8. Maximum: 356. |
result.data.result.numReplicas | integer | No | — | 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. See the live schema for the complete constraint. |
result.data.result.minReplicas | integer | No | — | Minimum number of replicas for horizontal autoscaling. Present only when the service uses horizontal autoscaling. Minimum: 1. Maximum: 20. |
result.data.result.maxReplicas | integer | No | — | Maximum number of replicas for horizontal autoscaling. Present only when the service uses horizontal autoscaling. Minimum: 1. Maximum: 20. |
result.data.result.autoscalingMode | "vertical" | "horizontal" | Yes | — | 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. Allowed: vertical, horizontal. |
result.data.result.replicaMemoryGb | number | No | — | 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. Minimum: 8. Maximum: 356. |
result.data.result.idleScaling | boolean | No | — | When set to true the service is allowed to scale down to zero when idle. True by default. |
result.data.result.idleTimeoutMinutes | number | No | — | Set minimum idling timeout (in minutes). Must be >= 5 minutes. |
result.data.result.ipAccessList | array | No | — | List of IP addresses allowed to access the service |
result.data.result.ipAccessList[].source | string | No | — | IP or CIDR |
result.data.result.ipAccessList[].description | string | No | — | Optional description of IPv4 address or IPv4 CIDR to allow access from |
result.data.result.createdAt | string | No | — | Service creation timestamp. ISO-8601. Format: date-time. |
result.data.result.encryptionKey | string | No | — | Optional customer provided disk encryption key |
result.data.result.encryptionAssumedRoleIdentifier | string | No | — | Optional role to use for disk encryption |
result.data.result.iamRole | string | No | — | IAM role used for accessing objects in s3 |
result.data.result.privateEndpointIds | array | No | — | List of private endpoints |
result.data.result.availablePrivateEndpointIds | array | No | — | List of available private endpoints ids that can be attached to the service |
result.data.result.dataWarehouseId | string | No | — | Data warehouse containing this service |
result.data.result.isPrimary | boolean | No | — | True if this service is the primary service in the data warehouse |
result.data.result.isReadonly | boolean | No | — | True if this service is read-only. It can only be read-only if a dataWarehouseId is provided. |
result.data.result.releaseChannel | "slow" | "default" | "fast" | No | — | 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. Allowed: slow, default, fast. |
result.data.result.byocId | string | No | — | 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. |
result.data.result.hasTransparentDataEncryption | boolean | No | — | 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. |
result.data.result.profile | "v1-default" | "v1-highmem-xs" | "v1-highmem-s" | "v1-highmem-m" | "v1-highmem-l" | "v1-highmem-xl" | No | — | Custom instance profile. Only available for ENTERPRISE organization tiers. Allowed: v1-default, v1-highmem-xs, v1-highmem-s, v1-highmem-m, v1-highmem-l, v1-highmem-xl. |
result.data.result.transparentDataEncryptionKeyId | string | No | — | The ID of the Transparent Data Encryption key used for the service. This is only available if hasTransparentDataEncryption is true. |
result.data.result.encryptionRoleId | string | No | — | The ID of the IAM role used for encryption. This is only available if hasTransparentDataEncryption is true. |
result.data.result.complianceType | "hipaa" | "pci" | No | — | Type of regulatory compliance for service. Allowed: hipaa, pci. |
result.data.result.tags | array | No | — | Tags associated with the service. Maximum items: 50. |
result.data.result.tags[].key | string | Yes | — | Tag key. Must be alphanumeric with dashes, underscores and dots. Minimum length: 1. Maximum length: 128. Pattern: ^[a-zA-Z0-9._-]+$. |
result.data.result.tags[].value | string | No | — | Tag value. Must be alphanumeric with dashes, underscores and dots. Maximum length: 256. Pattern: ^[a-zA-Z0-9._-]+$. |
result.data.result.enableCoreDumps | boolean | No | — | True if the service’s underline infra is enabled for collecting core dumps. This is an experimental feature |
This output schema is too large for an inline display. Read the complete live contract with
deepline describe clickhouse_instance_update --json.Deepline cost
- Pricing model:
fixed(per call). - Estimated Deepline credits:
0per pricing unit. - Provider-native pricing may still exist outside Deepline credit billing.