Saltar al contenido principal
PATCH
/
v1
/
organizations
/
{organizationId}
/
services
/
{serviceId}
/
scaling
Actualizar la configuración del escalado automático del servicio
curl --request PATCH \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/scaling \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idleScaling": true,
  "idleTimeoutMinutes": 123,
  "maxTotalMemoryGb": 360,
  "minTotalMemoryGb": 48,
  "numReplicas": 3
}
'
{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "availablePrivateEndpointIds": [
      "<string>"
    ],
    "byocId": "<string>",
    "clickhouseVersion": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "dataWarehouseId": "<string>",
    "encryptionAssumedRoleIdentifier": "<string>",
    "encryptionKey": "<string>",
    "encryptionRoleId": "<string>",
    "endpoints": [
      {
        "host": "<string>",
        "port": 123,
        "protocol": "mysql",
        "username": "<string>"
      }
    ],
    "hasTransparentDataEncryption": true,
    "iamRole": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "idleScaling": true,
    "idleTimeoutMinutes": 123,
    "ipAccessList": [
      {
        "description": "<string>",
        "source": "<string>"
      }
    ],
    "isPrimary": true,
    "isReadonly": true,
    "maxReplicaMemoryGb": 120,
    "maxTotalMemoryGb": 360,
    "minReplicaMemoryGb": 16,
    "minTotalMemoryGb": 48,
    "name": "<string>",
    "numReplicas": 3,
    "privateEndpointIds": [
      "<string>"
    ],
    "transparentDataEncryptionKeyId": "<string>"
  },
  "status": 200
}

Autorizaciones

Authorization
string
header
requerido

Usa el ID y el secreto de la clave obtenidos en la consola de ClickHouse Cloud: https://clickhouse.com/docs/cloud/manage/openapi

Parámetros de ruta

organizationId
string<uuid>
requerido

ID de la organización propietaria del servicio.

serviceId
string<uuid>
requerido

ID del servicio para actualizar los parámetros de scaling.

Cuerpo

application/json
idleScaling
boolean

Cuando se establece en true, el servicio puede escalar hasta cero cuando está inactivo. True de forma predeterminada.

idleTimeoutMinutes
number

Establezca el timeout mínimo de inactividad (en minutos). Debe ser >= 5 minutos.

maxTotalMemoryGb
number
obsoleto

OBSOLETO: inexacto para servicios con un número de réplicas distinto del predeterminado. Memoria máxima de tres workers durante el escalado automático, en Gb. Disponible solo para servicios 'production'. Debe ser un múltiplo de 12 y menor o igual que 360 para servicios no de pago o 1068 para servicios de pago.

Rango requerido: 24 <= x <= 1068Debe ser un múltiplo de 12
Ejemplo:

360

minTotalMemoryGb
number
obsoleto

OBSOLETO: inexacto para servicios con un número de réplicas distinto del predeterminado. Memoria mínima de tres workers durante el escalado automático, en Gb. Disponible solo para servicios 'production'. Debe ser un múltiplo de 12 y mayor o igual que 24.

Rango requerido: 24 <= x <= 1068Debe ser un múltiplo de 12
Ejemplo:

48

numReplicas
number

Número de réplicas del servicio. El número de réplicas debe estar entre 2 y 20 para el primer servicio de un warehouse. Los servicios que se crean en un warehouse existente pueden tener tan solo 1 réplica. Pueden aplicarse restricciones adicionales según el tier de su organización. El valor predeterminado es 1 para el tier BASIC y 3 para los tiers SCALE y ENTERPRISE.

Rango requerido: 1 <= x <= 20
Ejemplo:

3

Respuesta

Respuesta satisfactoria

requestId
string<uuid>

ID único asignado a cada solicitud. UUIDv4

result
object
status
number

Código de estado HTTP.

Ejemplo:

200

Última modificación el 10 de junio de 2026