Pular para o conteúdo principal
PATCH
/
v1
/
organizations
/
{organizationId}
/
services
/
{serviceId}
/
clickpipes
/
{clickPipeId}
/
scaling
Escalonamento do ClickPipe
curl --request PATCH \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/scaling \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "concurrency": 17,
  "replicaCpuMillicores": 1062,
  "replicaMemoryGb": 4.25,
  "replicas": 5
}
'
{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "createdAt": "<string>",
    "destination": {
      "columns": [
        {
          "name": "<string>",
          "type": "<string>"
        }
      ],
      "database": "<string>",
      "managedTable": true,
      "table": "<string>",
      "tableDefinition": {
        "engine": {
          "columnIds": [
            "<string>"
          ],
          "versionColumnId": "<string>"
        },
        "partitionBy": "<string>",
        "primaryKey": "<string>",
        "sortingKey": [
          "<string>"
        ]
      }
    },
    "fieldMappings": [
      {
        "destinationField": "<string>",
        "sourceField": "<string>"
      }
    ],
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "scaling": {
      "concurrency": 123,
      "replicaCpuMillicores": 1062,
      "replicaMemoryGb": 4.25,
      "replicas": 123
    },
    "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "settings": {
      "clickhouse_max_download_threads": 4,
      "clickhouse_max_insert_threads": 1,
      "clickhouse_max_threads": 8,
      "clickhouse_min_insert_block_size_bytes": 1073741824,
      "clickhouse_parallel_distributed_insert_select": 2,
      "clickhouse_parallel_view_processing": false,
      "object_storage_concurrency": 1,
      "object_storage_max_file_count": 100,
      "object_storage_max_insert_bytes": 10737418240,
      "object_storage_polling_interval_ms": 30000,
      "object_storage_use_cluster_function": true,
      "streaming_max_insert_wait_ms": 5000
    },
    "source": {
      "kafka": {
        "brokers": "<string>",
        "caCertificate": "<string>",
        "consumerGroup": "my-clickpipe-consumer-group",
        "iamRole": "arn:aws:iam::123456789012:role/MyRole",
        "offset": {
          "timestamp": "2021-01-01T00:00"
        },
        "reversePrivateEndpointIds": [
          "<string>"
        ],
        "schemaRegistry": {
          "authentication": "PLAIN",
          "caCertificate": "<string>",
          "url": "https://psrc-aa00.us-east-2.aws.confluent.cloud/schemas/ids/100004"
        },
        "topics": "<string>"
      },
      "kinesis": {
        "iamRole": "arn:aws:iam::123456789012:role/MyRole",
        "region": "us-east-1",
        "streamName": "my-stream",
        "timestamp": 1615766400,
        "useEnhancedFanOut": true
      },
      "objectStorage": {
        "azureContainerName": "mycontainer",
        "compression": "auto",
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=mykey;EndpointSuffix=core.windows.net",
        "delimiter": ",",
        "iamRole": "arn:aws:iam::123456789012:role/MyRole",
        "isContinuous": true,
        "path": "data/logs/*.json",
        "queueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue",
        "url": "https://datasets-documentation.s3.eu-west-3.amazonaws.com/http/**.ndjson.gz"
      },
      "postgres": {
        "database": "<string>",
        "host": "<string>",
        "port": 123,
        "settings": {
          "allowNullableColumns": true,
          "enableFailoverSlots": true,
          "initialLoadParallelism": 123,
          "publicationName": "<string>",
          "pullBatchSize": 123,
          "replicationSlotName": "<string>",
          "snapshotNumRowsPerPartition": 123,
          "snapshotNumberOfParallelTables": 123,
          "syncIntervalSeconds": 123
        },
        "tableMappings": [
          {
            "excludedColumns": [
              "<string>"
            ],
            "sortingKeys": [
              "<string>"
            ],
            "sourceSchemaName": "<string>",
            "sourceTable": "<string>",
            "targetTable": "<string>",
            "useCustomSortingKey": true
          }
        ]
      }
    },
    "state": "<string>",
    "updatedAt": "<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 à qual o serviço pertence.

​
serviceId
string<uuid>
obrigatório

ID do serviço ao qual o ClickPipe pertence.

​
clickPipeId
string<uuid>
obrigatório

ID do ClickPipe cujas configurações de escalonamento serão atualizadas.

Corpo

application/json
​
concurrency
integer | null

Nível de concorrência para escalonar. Use para escalonar pipes do S3.

Intervalo obrigatório: 0 <= x <= 34
​
replicaCpuMillicores
integer | null

CPU em millicores para cada réplica. Use para escalonar pipes de streaming.

Intervalo obrigatório: 125 <= x <= 2000
​
replicaMemoryGb
number | null

Memória em GB para cada réplica. Use para escalonar pipes de streaming.

Intervalo obrigatório: 0.5 <= x <= 8
​
replicas
integer | null

Número de réplicas para escalonar. Use para escalonar pipes do Kafka.

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

Resposta

Resposta bem-sucedida

​
requestId
string<uuid>

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

​
result
object
​
status
number

Código de status HTTP.

Exemplo:

200

Última modificação em 10 de junho de 2026