> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-home-button.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Escalonamento do ClickPipe

> **Este endpoint está em beta.** O contrato da API é estável, e não são esperadas mudanças incompatíveis no futuro. <br /><br /> Altere as configurações de escalonamento do ClickPipe especificado.



## OpenAPI

````yaml /pt-BR/products/cloud/api-reference/cloud-openapi.json patch /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/scaling
openapi: 3.0.1
info:
  contact:
    email: support@clickhouse.com
    name: ClickHouse Support
    url: >-
      https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-299828
  title: OpenAPI spec for ClickHouse Cloud
  version: '1.0'
servers:
  - url: https://api.clickhouse.cloud
security:
  - basicAuth: []
tags:
  - name: Organization
  - name: User management
  - name: Billing
  - name: Service
  - name: Backup
  - name: OpenAPI
  - name: Prometheus
  - name: ClickPipes
paths:
  /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/scaling:
    patch:
      tags:
        - ClickPipes
      summary: Escalonamento do ClickPipe
      description: >-
        **Este endpoint está em beta.** O contrato da API é estável, e não são
        esperadas mudanças incompatíveis no futuro. <br /><br /> Altere as
        configurações de escalonamento do ClickPipe especificado.
      parameters:
        - description: ID da organização à qual o serviço pertence.
          in: path
          name: organizationId
          required: true
          schema:
            format: uuid
            type: string
        - description: ID do serviço ao qual o ClickPipe pertence.
          in: path
          name: serviceId
          required: true
          schema:
            format: uuid
            type: string
        - description: >-
            ID do ClickPipe cujas configurações de escalonamento serão
            atualizadas.
          in: path
          name: clickPipeId
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClickPipeScalingPatchRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  requestId:
                    description: ID único atribuído a cada solicitação. UUIDv4
                    format: uuid
                    type: string
                  result:
                    $ref: '#/components/schemas/ClickPipe'
                  status:
                    description: Código de status HTTP.
                    example: 200
                    type: number
                type: object
          description: Resposta bem-sucedida
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    description: Descrição detalhada do erro.
                    type: string
                  status:
                    description: Código de status HTTP.
                    example: 400
                    type: number
                type: object
          description: >-
            O servidor não pode ou não quer processar a solicitação devido a
            algo entendido como um erro do cliente.
components:
  schemas:
    ClickPipeScalingPatchRequest:
      properties:
        concurrency:
          description: >-
            Nível de concorrência para escalonar. Use para escalonar pipes do
            S3.
          maximum: 34
          minimum: 0
          nullable: true
          type: integer
        replicaCpuMillicores:
          description: >-
            CPU em millicores para cada réplica. Use para escalonar pipes de
            streaming.
          maximum: 2000
          minimum: 125
          nullable: true
          type: integer
        replicaMemoryGb:
          description: >-
            Memória em GB para cada réplica. Use para escalonar pipes de
            streaming.
          maximum: 8
          minimum: 0.5
          nullable: true
          type: number
        replicas:
          description: >-
            Número de réplicas para escalonar. Use para escalonar pipes do
            Kafka.
          maximum: 10
          minimum: 1
          nullable: true
          type: integer
    ClickPipe:
      properties:
        createdAt:
          description: Data de criação do ClickPipe.
          type: string
        destination:
          $ref: '#/components/schemas/ClickPipeDestination'
        fieldMappings:
          description: >-
            Mapeamentos de campos do ClickPipe. Observe que todas as colunas de
            destino devem estar incluídas nos mapeamentos.
          items:
            $ref: '#/components/schemas/ClickPipeFieldMapping'
          type: array
        id:
          description: ID exclusivo do ClickPipe.
          format: uuid
          type: string
        name:
          description: Nome do ClickPipe.
          type: string
        scaling:
          $ref: '#/components/schemas/ClickPipeScaling'
        serviceId:
          description: ID do serviço ao qual este ClickPipe pertence.
          format: uuid
          type: string
        settings:
          $ref: '#/components/schemas/ClickPipeSettings'
        source:
          $ref: '#/components/schemas/ClickPipeSource'
        state:
          description: Estado atual do ClickPipe.
          type: string
        updatedAt:
          description: Data da última atualização do ClickPipe.
          type: string
    ClickPipeDestination:
      properties:
        columns:
          description: >-
            Colunas da tabela de destino. Campo obrigatório para todos os tipos
            de pipe, exceto Postgres.
          items:
            $ref: '#/components/schemas/ClickPipeDestinationColumn'
          type: array
        database:
          description: Banco de dados de destino.
          type: string
        managedTable:
          description: >-
            A tabela é gerenciada pelo ClickPipes? Campo obrigatório para todos
            os tipos de pipe, exceto Postgres.
          type: boolean
        table:
          description: >-
            Tabela de destino. Campo obrigatório para todos os os tipos de pipe,
            exceto Postgres.
          type: string
        tableDefinition:
          $ref: '#/components/schemas/ClickPipeDestinationTableDefinition'
    ClickPipeFieldMapping:
      properties:
        destinationField:
          description: Nome do campo de destino.
          type: string
        sourceField:
          description: Nome do campo de origem.
          type: string
    ClickPipeScaling:
      properties:
        concurrency:
          deprecated: true
          description: >-
            Nível desejado de concorrência. Somente para pipes S3. Se definido
            como 0, a concorrência é ajustada automaticamente com base na
            memória do cluster.
          type: integer
        replicaCpuMillicores:
          description: >-
            CPU em millicores para cada réplica. Somente para pipes de
            streaming.
          maximum: 2000
          minimum: 125
          type: integer
        replicaMemoryGb:
          description: Memória em GB para cada réplica. Somente para pipes de streaming.
          maximum: 8
          minimum: 0.5
          type: number
        replicas:
          description: Número desejado de réplicas. Somente para pipes escaláveis.
          type: integer
    ClickPipeSettings:
      properties:
        clickhouse_max_download_threads:
          description: >-
            Máximo de threads de download. Número máximo de threads simultâneas
            de download
          example: 4
          maximum: 32
          minimum: 0
          nullable: true
          type: integer
        clickhouse_max_insert_threads:
          description: >-
            Máximo de threads de insert. Número máximo de threads simultâneas de
            insert
          example: 1
          maximum: 16
          minimum: 0
          nullable: true
          type: integer
        clickhouse_max_threads:
          description: >-
            Máximo de threads. Número máximo de threads simultâneas para
            processamento de arquivos
          example: 8
          maximum: 64
          minimum: 0
          nullable: true
          type: integer
        clickhouse_min_insert_block_size_bytes:
          description: >-
            Tamanho mínimo do bloco de insert em bytes. Tamanho mínimo do bloco
            de dados para insert (em bytes)
          example: 1073741824
          maximum: 10737418240
          minimum: 0
          nullable: true
          type: integer
        clickhouse_parallel_distributed_insert_select:
          description: >-
            Insert select distribuído em paralelo. Configuração de insert select
            distribuído em paralelo
          example: 2
          maximum: 2
          minimum: 0
          nullable: true
          type: integer
        clickhouse_parallel_view_processing:
          description: >-
            processamento paralelo de views. Define se o envio para views
            anexadas deve ser feito de forma simultânea em vez de sequencial
          example: false
          nullable: true
          type: boolean
        object_storage_concurrency:
          description: >-
            Concorrência do armazenamento de objetos. Número de threads
            simultâneas de processamento de arquivos
          example: 1
          maximum: 35
          minimum: 1
          nullable: true
          type: integer
        object_storage_max_file_count:
          description: >-
            Número máximo de arquivos. Número máximo de arquivos a processar em
            um único batch de insert
          example: 100
          maximum: 10000
          minimum: 1
          nullable: true
          type: integer
        object_storage_max_insert_bytes:
          description: >-
            Máximo de bytes por insert. Número de bytes a processar em um único
            batch de insert
          example: 10737418240
          maximum: 53687091200
          minimum: 10485760
          nullable: true
          type: integer
        object_storage_polling_interval_ms:
          description: >-
            Intervalo de sondagem do armazenamento de objetos. Configura o
            intervalo de atualização para consultar a ingestão contínua em busca
            de novos dados no armazenamento de objetos
          example: 30000
          maximum: 3600000
          minimum: 100
          nullable: true
          type: integer
        object_storage_use_cluster_function:
          description: >-
            usar função cluster. Define se a função cluster do ClickHouse será
            usada para processamento distribuído
          example: true
          nullable: true
          type: boolean
        streaming_max_insert_wait_ms:
          description: >-
            Tempo máximo de espera para insert em streaming. Configura o tempo
            máximo de espera antes de inserir dados no ClickHouse.
          example: 5000
          maximum: 60000
          minimum: 500
          nullable: true
          type: integer
    ClickPipeSource:
      properties:
        kafka:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/ClickPipeKafkaSource'
        kinesis:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/ClickPipeKinesisSource'
        objectStorage:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/ClickPipeObjectStorageSource'
        postgres:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/ClickPipePostgresSource'
    ClickPipeDestinationColumn:
      properties:
        name:
          description: Nome da coluna.
          type: string
        type:
          description: Tipo da coluna.
          type: string
    ClickPipeDestinationTableDefinition:
      properties:
        engine:
          $ref: '#/components/schemas/ClickPipeDestinationTableEngine'
        partitionBy:
          description: Expressão SQL da chave de partição.
          type: string
        primaryKey:
          description: Chave primária da expressão SQL.
          type: string
        sortingKey:
          description: Chave de ordenação da tabela de destino. Lista de colunas.
          items:
            type: string
          type: array
    ClickPipeKafkaSource:
      properties:
        authentication:
          description: >-
            Método de autenticação da source do Kafka. Métodos de autenticação
            compatíveis: kafka: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, MUTUAL_TLS,
            msk: SCRAM-SHA-512, IAM_ROLE, IAM_USER, MUTUAL_TLS, confluent:
            PLAIN, MUTUAL_TLS, warpstream: PLAIN, azureeventhub: PLAIN,
            redpanda: SCRAM-SHA-256, SCRAM-SHA-512, MUTUAL_TLS, dokafka:
            SCRAM-SHA-256, MUTUAL_TLS
          enum:
            - PLAIN
            - SCRAM-SHA-256
            - SCRAM-SHA-512
            - IAM_ROLE
            - IAM_USER
            - MUTUAL_TLS
          type: string
        brokers:
          description: Brokers da source do Kafka.
          type: string
        caCertificate:
          description: >-
            Certificados CA codificados em PEM para validar o certificado do
            broker.
          nullable: true
          type: string
        consumerGroup:
          description: >-
            Grupo de consumidores da source do Kafka. Se não for fornecido,
            "clickpipes-<<ID>>" será usado.
          example: my-clickpipe-consumer-group
          nullable: true
          type: string
        format:
          description: Formato da source do Kafka.
          enum:
            - JSONEachRow
            - Avro
            - AvroConfluent
          type: string
        iamRole:
          description: >-
            IAM role da source do Kafka. Use com autenticação por IAM role. Leia
            mais na documentação do ClickPipes:
            https://clickhouse.com/docs/en/integrations/clickpipes/kafka#iam
          example: arn:aws:iam::123456789012:role/MyRole
          nullable: true
          type: string
        offset:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/ClickPipeKafkaOffset'
        reversePrivateEndpointIds:
          description: >-
            UUIDs de Reverse Private Endpoint usados para uma conexão privada
            segura com a source do Kafka.
          items:
            type: string
          type: array
        schemaRegistry:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/ClickPipeKafkaSchemaRegistry'
        topics:
          description: Tópicos da source do Kafka.
          type: string
        type:
          description: Tipo da source do Kafka.
          enum:
            - kafka
            - redpanda
            - msk
            - confluent
            - warpstream
            - azureeventhub
            - dokafka
          type: string
    ClickPipeKinesisSource:
      properties:
        authentication:
          description: Método de autenticação a ser usado com o Kinesis Stream.
          enum:
            - IAM_ROLE
            - IAM_USER
          type: string
        format:
          description: Formato do Kinesis Stream.
          enum:
            - JSONEachRow
            - Avro
            - AvroConfluent
          type: string
        iamRole:
          description: >-
            IAM role a ser usada para autenticação. Obrigatório se IAM_ROLE for
            usado.
          example: arn:aws:iam::123456789012:role/MyRole
          nullable: true
          type: string
        iteratorType:
          description: >-
            Tipo de iterador a ser usado na leitura do Kinesis Stream. Se
            AT_TIMESTAMP for usado, o campo timestamp deverá ser fornecido.
          enum:
            - TRIM_HORIZON
            - LATEST
            - AT_TIMESTAMP
          type: string
        region:
          description: Região da AWS do Kinesis Stream.
          example: us-east-1
          type: string
        streamName:
          description: Nome do Kinesis Stream.
          example: my-stream
          type: string
        timestamp:
          description: >-
            Unix timestamp para iniciar a leitura do Kinesis Stream. Obrigatório
            se iteratorType for AT_TIMESTAMP.
          example: 1615766400
          nullable: true
          type: integer
        useEnhancedFanOut:
          description: Usa enhanced fan-out para o Kinesis Stream.
          nullable: true
          type: boolean
    ClickPipeObjectStorageSource:
      properties:
        authentication:
          description: >-
            Método de autenticação. CONNECTION_STRING é para Azure Blob Storage.
            IAM_ROLE e IAM_USER são para AWS S3/GCS/DigitalOcean. Se não for
            fornecido, nenhuma autenticação será usada.
          enum:
            - IAM_ROLE
            - IAM_USER
            - CONNECTION_STRING
          nullable: true
          type: string
        azureContainerName:
          description: >-
            Nome do Container do Azure Blob Storage. Obrigatório quando type é
            azureblobstorage.
          example: mycontainer
          nullable: true
          type: string
        compression:
          description: Algoritmo de compressão usado nos arquivos.
          enum:
            - gzip
            - gz
            - brotli
            - br
            - xz
            - LZMA
            - zstd
            - auto
          example: auto
          nullable: true
          type: string
        connectionString:
          description: >-
            Connection string para autenticação do Azure Blob Storage.
            Obrigatória quando authentication é CONNECTION_STRING.
          example: >-
            DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=mykey;EndpointSuffix=core.windows.net
          nullable: true
          type: string
        delimiter:
          description: Delimitador usado nos arquivos.
          example: ','
          nullable: true
          type: string
        format:
          description: Formato dos arquivos.
          enum:
            - JSONEachRow
            - JSONAsObject
            - CSV
            - CSVWithNames
            - Parquet
            - Avro
          type: string
        iamRole:
          description: >-
            IAM role a ser usada com autenticação por IAM role. Leia mais na
            documentação do ClickPipes:
            https://clickhouse.com/docs/en/integrations/clickpipes/object-storage#authentication
          example: arn:aws:iam::123456789012:role/MyRole
          nullable: true
          type: string
        isContinuous:
          description: >-
            Se definido como true, o pipe lerá continuamente novos arquivos da
            source. Se definido como false, o pipe lerá os arquivos apenas uma
            vez. Os novos arquivos devem ser enviados em ordem lexicográfica.
          nullable: true
          type: boolean
        path:
          description: >-
            Caminho para o(s) arquivo(s) dentro do Azure container. Usado para
            sources do Azure Blob Storage. Você pode especificar vários arquivos
            usando wildcards no estilo bash. Para mais informações, consulte a
            documentação sobre o uso de wildcards em caminhos:
            https://clickhouse.com/docs/en/integrations/clickpipes/object-storage#limitations
          example: data/logs/*.json
          nullable: true
          type: string
        queueUrl:
          description: >-
            URL da fila SQS para ingestão contínua baseada em eventos. Quando
            fornecida, os arquivos são ingeridos com base em notificações de
            eventos do S3, em vez de seguir a ordem lexicográfica. Aplicável
            somente quando isContinuous é true e a autenticação não é pública.
          example: https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue
          nullable: true
          type: string
        type:
          description: Tipo da source ObjectStorage.
          enum:
            - s3
            - gcs
            - dospaces
            - azureblobstorage
          type: string
        url:
          description: >-
            Forneça um caminho para o(s) arquivo(s) que você deseja ingerir.
            Você pode especificar vários arquivos usando wildcards no estilo
            bash. Para mais informações, consulte a documentação sobre o uso de
            wildcards em caminhos:
            https://clickhouse.com/docs/en/integrations/clickpipes/object-storage#limitations
          example: >-
            https://datasets-documentation.s3.eu-west-3.amazonaws.com/http/**.ndjson.gz
          type: string
    ClickPipePostgresSource:
      properties:
        database:
          description: Banco de dados da instância do Postgres à qual se conectar.
          type: string
        host:
          description: Host da instância do Postgres à qual se conectar.
          type: string
        port:
          description: Porta da instância do Postgres à qual se conectar.
          type: number
        settings:
          $ref: '#/components/schemas/ClickPipePostgresPipeSettings'
        tableMappings:
          description: Mapeamentos de tabela para o pipe do Postgres.
          items:
            $ref: '#/components/schemas/ClickPipePostgresPipeTableMapping'
          type: array
    ClickPipeDestinationTableEngine:
      properties:
        columnIds:
          description: Nomes das colunas a serem somadas para o engine SummingMergeTree.
          items:
            type: string
          type: array
        type:
          description: Tipo de engine da tabela de destino.
          enum:
            - MergeTree
            - ReplacingMergeTree
            - SummingMergeTree
            - 'Null'
          type: string
        versionColumnId:
          description: >-
            Nome da coluna a ser usada como versão para o engine
            ReplacingMergeTree.
          nullable: true
          type: string
    ClickPipeKafkaOffset:
      properties:
        strategy:
          description: Estratégia de offset.
          enum:
            - from_beginning
            - from_latest
            - from_timestamp
          type: string
        timestamp:
          description: >-
            Timestamp UTC com precisão de minuto a partir do qual iniciar.
            Obrigatório para a estratégia "from_timestamp".
          example: 2021-01-01T00:00
          nullable: true
          type: string
    ClickPipeKafkaSchemaRegistry:
      properties:
        authentication:
          description: Tipo de autenticação do schema registry.
          enum:
            - PLAIN
          type: string
        caCertificate:
          description: >-
            Certificados CA codificados em PEM para validar o certificado do
            schema registry.
          nullable: true
          type: string
        url:
          description: URL do schema. HTTPS é obrigatório.
          example: https://psrc-aa00.us-east-2.aws.confluent.cloud/schemas/ids/100004
          type: string
    ClickPipePostgresPipeSettings:
      properties:
        allowNullableColumns:
          description: Permitir colunas Nullable na tabela de destino.
          type: boolean
        enableFailoverSlots:
          description: >-
            Ativar failover para o slot de replicação criado. Exige que nenhum
            slot de replicação esteja definido.
          type: boolean
        initialLoadParallelism:
          description: >-
            Número de tabelas paralelas a serem sincronizadas durante a carga
            inicial.
          type: number
        publicationName:
          description: Nome da publicação a ser usado para replicação.
          type: string
        pullBatchSize:
          description: Número de linhas a serem extraídas em cada lote.
          type: number
        replicationMode:
          description: Modo de replicação a ser usado para o pipe.
          enum:
            - cdc
            - snapshot
            - cdc_only
          type: string
        replicationSlotName:
          description: Nome do slot de replicação a ser usado para replicação.
          type: string
        snapshotNumRowsPerPartition:
          description: Número de linhas para capturar no snapshot por partição.
          type: number
        snapshotNumberOfParallelTables:
          description: Número de tabelas paralelas para capturar no snapshot.
          type: number
        syncIntervalSeconds:
          description: Intervalo em segundos para sincronizar dados do Postgres.
          type: number
    ClickPipePostgresPipeTableMapping:
      properties:
        excludedColumns:
          description: Colunas a serem excluídas da tabela de destino.
          items:
            type: string
          type: array
        sortingKeys:
          description: >-
            Lista ordenada de colunas a ser usada como chave de ordenação da
            tabela de destino.
          items:
            type: string
          type: array
        sourceSchemaName:
          description: Nome do schema de origem.
          type: string
        sourceTable:
          description: Nome da tabela de origem.
          type: string
        tableEngine:
          description: Engine de tabela a ser usado para a tabela de destino.
          enum:
            - MergeTree
            - ReplacingMergeTree
            - 'Null'
          type: string
        targetTable:
          description: Nome da tabela de destino.
          type: string
        useCustomSortingKey:
          description: >-
            Se deve ser usada uma chave de ordenação personalizada para a tabela
            de destino.
          type: boolean
  securitySchemes:
    basicAuth:
      description: >-
        Use o ID da chave e o segredo da chave obtidos no ClickHouse Cloud
        console: https://clickhouse.com/docs/cloud/manage/openapi
      scheme: basic
      type: http

````