Atualizar as configurações de escalonamento automático do serviço

Atualiza os limites mínimo e máximo de memória por réplica e o comportamento de scaling no modo idle do serviço. As configurações de memória estão disponíveis apenas para serviços “production” e devem ser múltiplos de 4, a partir de 8GB. Entre em contato com o suporte para habilitar o ajuste de numReplicas.

PATCH /v1/organizations/{organizationId}/services/{serviceId}/replicaScaling

Atualizar as configurações de escalonamento automático do serviço

cURL

curl --request PATCH \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/replicaScaling \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idleScaling": true,
  "idleTimeoutMinutes": 123,
  "maxReplicaMemoryGb": 120,
  "minReplicaMemoryGb": 16,
  "numReplicas": 3
}
'

200

{
  "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
}

Autorizações

Authorization · string · header · obrigatório

Use o ID da chave e o segredo da chave obtidos no ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Parâmetros de caminho

organizationId · string<uuid> · obrigatório

ID da organização proprietária do serviço.

serviceId · string<uuid> · obrigatório

ID do serviço para atualizar os parâmetros de scaling.

Corpo

application/json

idleScaling · boolean

Quando definido como true, o serviço pode reduzir para zero quando estiver ocioso. True por padrão.

idleTimeoutMinutes · number

Define o timeout mínimo de ociosidade (em minutos). Deve ser >= 5 minutos.

maxReplicaMemoryGb · number

Memória máxima para auto scaling em Gb para uma única réplica. Disponível apenas para serviços 'production'. Deve ser um múltiplo de 4 e menor ou igual a 120 para serviços não pagos ou 356 para serviços pagos.

Intervalo obrigatório: 8 <= x <= 356Deve ser um múltiplo de 4

Exemplo:

120

minReplicaMemoryGb · number

Memória mínima para auto scaling em Gb para uma única réplica. Disponível apenas para serviços 'production'. Deve ser um múltiplo de 4 e maior ou igual a 8.

Intervalo obrigatório: 8 <= x <= 356Deve ser um múltiplo de 4

Exemplo:

16

numReplicas · number

Número de réplicas do serviço. O número de réplicas deve estar entre 2 e 20 para o primeiro serviço em um warehouse. Serviços criados em um warehouse existente podem ter apenas 1 réplica. Restrições adicionais podem ser aplicadas com base no tier da sua organization. O padrão é 1 para o tier BASIC e 3 para os tiers SCALE e ENTERPRISE.

Intervalo obrigatório: 1 <= x <= 20

Exemplo:

3

Resposta

200

application/json

Resposta bem-sucedida

requestId · string<uuid>

ID exclusivo atribuído a cada solicitação. UUIDv4

result · object

Show child attributes

status · number

Código de status HTTP.

Exemplo:

200