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

# Обновить состояние ClickPipe

> **Эта конечная точка находится в бета-версии.** Контракт API стабилен, и в будущем не ожидается несовместимых изменений. <br /><br /> Запустите, остановите или повторно синхронизируйте ClickPipe. Остановка ClickPipe прекращает процесс ингестии из любого состояния. Запуск допускается для ClickPipes в состоянии "Stopped" или "Failed". Повторная синхронизация доступна только для пайпов Postgres и может быть выполнена из любого состояния.



## OpenAPI

````yaml /ru/products/cloud/api-reference/cloud-openapi.json patch /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/state
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}/state:
    patch:
      tags:
        - ClickPipes
      summary: Обновить состояние ClickPipe
      description: >-
        **Эта конечная точка находится в бета-версии.** Контракт API стабилен, и
        в будущем не ожидается несовместимых изменений. <br /><br /> Запустите,
        остановите или повторно синхронизируйте ClickPipe. Остановка ClickPipe
        прекращает процесс ингестии из любого состояния. Запуск допускается для
        ClickPipes в состоянии "Stopped" или "Failed". Повторная синхронизация
        доступна только для пайпов Postgres и может быть выполнена из любого
        состояния.
      parameters:
        - description: ID организации, которой принадлежит сервис.
          in: path
          name: organizationId
          required: true
          schema:
            format: uuid
            type: string
        - description: ID сервиса, которому принадлежит ClickPipe.
          in: path
          name: serviceId
          required: true
          schema:
            format: uuid
            type: string
        - description: ID ClickPipe, для которого нужно обновить состояние.
          in: path
          name: clickPipeId
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClickPipeStatePatchRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  requestId:
                    description: >-
                      Уникальный идентификатор, назначаемый каждому запросу.
                      UUIDv4
                    format: uuid
                    type: string
                  result:
                    $ref: '#/components/schemas/ClickPipe'
                  status:
                    description: Код состояния HTTP.
                    example: 200
                    type: number
                type: object
          description: Успешный ответ
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    description: Подробное описание ошибки.
                    type: string
                  status:
                    description: Код состояния HTTP.
                    example: 400
                    type: number
                type: object
          description: >-
            Сервер не может или не будет обрабатывать запрос из-за ошибки,
            которая воспринимается как ошибка на стороне клиента.
components:
  schemas:
    ClickPipeStatePatchRequest:
      properties:
        command:
          description: 'Команда для изменения состояния: ''start'', ''stop'', ''resync''.'
          enum:
            - start
            - stop
            - resync
          type: string
    ClickPipe:
      properties:
        createdAt:
          description: Дата создания ClickPipe.
          type: string
        destination:
          $ref: '#/components/schemas/ClickPipeDestination'
        fieldMappings:
          description: >-
            Сопоставления полей ClickPipe. Обратите внимание, что в
            сопоставления должны быть включены все целевые столбцы.
          items:
            $ref: '#/components/schemas/ClickPipeFieldMapping'
          type: array
        id:
          description: Уникальный идентификатор ClickPipe.
          format: uuid
          type: string
        name:
          description: Имя ClickPipe.
          type: string
        scaling:
          $ref: '#/components/schemas/ClickPipeScaling'
        serviceId:
          description: Идентификатор сервиса, к которому относится этот ClickPipe.
          format: uuid
          type: string
        settings:
          $ref: '#/components/schemas/ClickPipeSettings'
        source:
          $ref: '#/components/schemas/ClickPipeSource'
        state:
          description: Текущее состояние ClickPipe.
          type: string
        updatedAt:
          description: Дата последнего обновления ClickPipe.
          type: string
    ClickPipeDestination:
      properties:
        columns:
          description: >-
            Столбцы целевой таблицы. Обязательное поле для всех типов пайпов,
            кроме Postgres.
          items:
            $ref: '#/components/schemas/ClickPipeDestinationColumn'
          type: array
        database:
          description: Целевая база данных.
          type: string
        managedTable:
          description: >-
            Управляется ли таблица через ClickPipes? Обязательное поле для всех
            типов пайпов, кроме Postgres.
          type: boolean
        table:
          description: >-
            Целевая таблица. Обязательное поле для всех типов пайпов, кроме
            Postgres.
          type: string
        tableDefinition:
          $ref: '#/components/schemas/ClickPipeDestinationTableDefinition'
    ClickPipeFieldMapping:
      properties:
        destinationField:
          description: Имя целевого поля.
          type: string
        sourceField:
          description: Имя исходного поля.
          type: string
    ClickPipeScaling:
      properties:
        concurrency:
          deprecated: true
          description: >-
            Требуемый уровень параллелизма. Только для пайпов S3. Если задано
            значение 0, параллелизм автоматически масштабируется в зависимости
            от памяти кластера.
          type: integer
        replicaCpuMillicores:
          description: CPU в милликорях для каждой реплики. Только для стриминг-пайпов.
          maximum: 2000
          minimum: 125
          type: integer
        replicaMemoryGb:
          description: Память в ГБ для каждой реплики. Только для стриминг-пайпов.
          maximum: 8
          minimum: 0.5
          type: number
        replicas:
          description: Требуемое количество реплик. Только для масштабируемых пайпов.
          type: integer
    ClickPipeSettings:
      properties:
        clickhouse_max_download_threads:
          description: >-
            Максимальное количество потоков загрузки. Максимальное число
            параллельных потоков загрузки
          example: 4
          maximum: 32
          minimum: 0
          nullable: true
          type: integer
        clickhouse_max_insert_threads:
          description: >-
            Максимальное количество потоков вставки. Максимальное число
            параллельных потоков вставки
          example: 1
          maximum: 16
          minimum: 0
          nullable: true
          type: integer
        clickhouse_max_threads:
          description: >-
            Максимальное количество потоков. Максимальное число потоков для
            параллельной обработки файлов
          example: 8
          maximum: 64
          minimum: 0
          nullable: true
          type: integer
        clickhouse_min_insert_block_size_bytes:
          description: >-
            Минимальный размер блока вставки в байтах. Минимальный размер блока
            данных для вставки (в байтах)
          example: 1073741824
          maximum: 10737418240
          minimum: 0
          nullable: true
          type: integer
        clickhouse_parallel_distributed_insert_select:
          description: >-
            Параллельный distributed insert select. Настройка parallel
            distributed insert select
          example: 2
          maximum: 2
          minimum: 0
          nullable: true
          type: integer
        clickhouse_parallel_view_processing:
          description: >-
            параллельная обработка представлений. Включать ли параллельную
            отправку в attached-представления вместо последовательной
          example: false
          nullable: true
          type: boolean
        object_storage_concurrency:
          description: >-
            Параллелизм объектного хранилища. Количество потоков для
            параллельной обработки файлов
          example: 1
          maximum: 35
          minimum: 1
          nullable: true
          type: integer
        object_storage_max_file_count:
          description: >-
            Максимальное количество файлов. Максимальное число файлов для
            обработки в одном батче вставки
          example: 100
          maximum: 10000
          minimum: 1
          nullable: true
          type: integer
        object_storage_max_insert_bytes:
          description: >-
            Максимальный объём вставки в байтах. Количество байтов для обработки
            в одном батче вставки
          example: 10737418240
          maximum: 53687091200
          minimum: 10485760
          nullable: true
          type: integer
        object_storage_polling_interval_ms:
          description: >-
            Интервал опроса объектного хранилища. Задаёт интервал обновления для
            проверки наличия новых данных в объектном хранилище при непрерывном
            приёме
          example: 30000
          maximum: 3600000
          minimum: 100
          nullable: true
          type: integer
        object_storage_use_cluster_function:
          description: >-
            использовать функцию cluster. Использовать ли функцию cluster в
            ClickHouse для распределённой обработки
          example: true
          nullable: true
          type: boolean
        streaming_max_insert_wait_ms:
          description: >-
            Максимальное время ожидания вставки для стриминга. Задаёт
            максимальный период ожидания перед вставкой данных в 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: Имя столбца.
          type: string
        type:
          description: Тип столбца.
          type: string
    ClickPipeDestinationTableDefinition:
      properties:
        engine:
          $ref: '#/components/schemas/ClickPipeDestinationTableEngine'
        partitionBy:
          description: SQL-выражение ключа партиционирования.
          type: string
        primaryKey:
          description: SQL-выражение первичного ключа.
          type: string
        sortingKey:
          description: Ключ сортировки целевой таблицы. Список столбцов.
          items:
            type: string
          type: array
    ClickPipeKafkaSource:
      properties:
        authentication:
          description: >-
            Метод аутентификации для источника Kafka. Поддерживаемые методы
            аутентификации: 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: Брокеры источника Kafka.
          type: string
        caCertificate:
          description: CA‑сертификаты в кодировке PEM для проверки сертификата брокера.
          nullable: true
          type: string
        consumerGroup:
          description: >-
            Группа потребителей для источника Kafka. Если не указана, будет
            использоваться "clickpipes-<<ID>>".
          example: my-clickpipe-consumer-group
          nullable: true
          type: string
        format:
          description: Формат источника Kafka.
          enum:
            - JSONEachRow
            - Avro
            - AvroConfluent
          type: string
        iamRole:
          description: >-
            Роль IAM для источника Kafka. Используйте с аутентификацией по роли
            IAM. Подробнее см. в документации 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: >-
            UUID обратных частных конечных точек для безопасного частного
            подключения к источнику Kafka.
          items:
            type: string
          type: array
        schemaRegistry:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/ClickPipeKafkaSchemaRegistry'
        topics:
          description: Топики источника Kafka.
          type: string
        type:
          description: Тип источника Kafka.
          enum:
            - kafka
            - redpanda
            - msk
            - confluent
            - warpstream
            - azureeventhub
            - dokafka
          type: string
    ClickPipeKinesisSource:
      properties:
        authentication:
          description: Метод аутентификации для потока Kinesis.
          enum:
            - IAM_ROLE
            - IAM_USER
          type: string
        format:
          description: Формат потока Kinesis.
          enum:
            - JSONEachRow
            - Avro
            - AvroConfluent
          type: string
        iamRole:
          description: >-
            Роль IAM для аутентификации. Обязательно, если используется
            IAM_ROLE.
          example: arn:aws:iam::123456789012:role/MyRole
          nullable: true
          type: string
        iteratorType:
          description: >-
            Тип итератора, используемый при чтении из потока Kinesis. Если
            используется AT_TIMESTAMP, необходимо указать поле временной метки.
          enum:
            - TRIM_HORIZON
            - LATEST
            - AT_TIMESTAMP
          type: string
        region:
          description: Регион AWS для потока Kinesis.
          example: us-east-1
          type: string
        streamName:
          description: Имя потока Kinesis.
          example: my-stream
          type: string
        timestamp:
          description: >-
            Unix-временная метка, с которой следует начать чтение из потока
            Kinesis. Обязательно, если iteratorType имеет значение AT_TIMESTAMP.
          example: 1615766400
          nullable: true
          type: integer
        useEnhancedFanOut:
          description: Использовать enhanced fan-out для потока Kinesis.
          nullable: true
          type: boolean
    ClickPipeObjectStorageSource:
      properties:
        authentication:
          description: >-
            Метод аутентификации. CONNECTION_STRING используется для Azure Blob
            Storage. IAM_ROLE и IAM_USER — для AWS S3/GCS/DigitalOcean. Если не
            указан, аутентификация не используется.
          enum:
            - IAM_ROLE
            - IAM_USER
            - CONNECTION_STRING
          nullable: true
          type: string
        azureContainerName:
          description: >-
            Имя контейнера для Azure Blob Storage. Обязательно, если type имеет
            значение azureblobstorage.
          example: mycontainer
          nullable: true
          type: string
        compression:
          description: Алгоритм сжатия, используемый для файлов.
          enum:
            - gzip
            - gz
            - brotli
            - br
            - xz
            - LZMA
            - zstd
            - auto
          example: auto
          nullable: true
          type: string
        connectionString:
          description: >-
            Строка подключения для аутентификации в Azure Blob Storage.
            Обязательно, если authentication имеет значение CONNECTION_STRING.
          example: >-
            DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=mykey;EndpointSuffix=core.windows.net
          nullable: true
          type: string
        delimiter:
          description: Разделитель, используемый в файлах.
          example: ','
          nullable: true
          type: string
        format:
          description: Формат файлов.
          enum:
            - JSONEachRow
            - JSONAsObject
            - CSV
            - CSVWithNames
            - Parquet
            - Avro
          type: string
        iamRole:
          description: >-
            Роль IAM, используемая при аутентификации через роль IAM. Подробнее
            см. в документации ClickPipes:
            https://clickhouse.com/docs/en/integrations/clickpipes/object-storage#authentication
          example: arn:aws:iam::123456789012:role/MyRole
          nullable: true
          type: string
        isContinuous:
          description: >-
            Если установлено значение true, пайп будет непрерывно читать новые
            файлы из источника. Если установлено значение false, пайп прочитает
            файлы только один раз. Новые файлы должны загружаться в
            лексикографическом порядке.
          nullable: true
          type: boolean
        path:
          description: >-
            Путь к файлу или файлам в контейнере Azure. Используется для
            источников Azure Blob Storage. Можно указать несколько файлов,
            используя bash-подобные подстановочные шаблоны. Подробнее см. в
            документации по использованию подстановочных шаблонов в пути:
            https://clickhouse.com/docs/en/integrations/clickpipes/object-storage#limitations
          example: data/logs/*.json
          nullable: true
          type: string
        queueUrl:
          description: >-
            URL очереди SQS для событийной непрерывной ингестии. Если указан,
            файлы загружаются на основе уведомлений о событиях S3, а не в
            лексикографическом порядке. Применимо только если isContinuous имеет
            значение true и authentication не имеет значения public.
          example: https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue
          nullable: true
          type: string
        type:
          description: Тип источника ObjectStorage.
          enum:
            - s3
            - gcs
            - dospaces
            - azureblobstorage
          type: string
        url:
          description: >-
            Укажите путь к файлу или файлам, которые нужно загрузить. Можно
            указать несколько файлов, используя bash-подобные подстановочные
            шаблоны. Подробнее см. в документации по использованию
            подстановочных шаблонов в пути:
            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: База данных экземпляра Postgres, к которому нужно подключиться.
          type: string
        host:
          description: Хост экземпляра Postgres, к которому нужно подключиться.
          type: string
        port:
          description: Порт экземпляра Postgres, к которому нужно подключиться.
          type: number
        settings:
          $ref: '#/components/schemas/ClickPipePostgresPipeSettings'
        tableMappings:
          description: Сопоставления таблиц для пайпа Postgres.
          items:
            $ref: '#/components/schemas/ClickPipePostgresPipeTableMapping'
          type: array
    ClickPipeDestinationTableEngine:
      properties:
        columnIds:
          description: Имена столбцов для суммирования в движке SummingMergeTree.
          items:
            type: string
          type: array
        type:
          description: Тип движка целевой таблицы.
          enum:
            - MergeTree
            - ReplacingMergeTree
            - SummingMergeTree
            - 'Null'
          type: string
        versionColumnId:
          description: Имя столбца, используемого как версия для движка ReplacingMergeTree.
          nullable: true
          type: string
    ClickPipeKafkaOffset:
      properties:
        strategy:
          description: Стратегия смещения.
          enum:
            - from_beginning
            - from_latest
            - from_timestamp
          type: string
        timestamp:
          description: >-
            Временная метка UTC с точностью до минуты, с которой следует начать.
            Обязательно для стратегии "from_timestamp".
          example: 2021-01-01T00:00
          nullable: true
          type: string
    ClickPipeKafkaSchemaRegistry:
      properties:
        authentication:
          description: Тип аутентификации для schema registry.
          enum:
            - PLAIN
          type: string
        caCertificate:
          description: >-
            CA‑сертификаты в кодировке PEM для проверки сертификата schema
            registry.
          nullable: true
          type: string
        url:
          description: URL схемы. Требуется HTTPS.
          example: https://psrc-aa00.us-east-2.aws.confluent.cloud/schemas/ids/100004
          type: string
    ClickPipePostgresPipeSettings:
      properties:
        allowNullableColumns:
          description: Разрешить использование столбцов с типом Nullable в целевой таблице.
          type: boolean
        enableFailoverSlots:
          description: >-
            Включить аварийное переключение для созданного слота репликации.
            Требуется, чтобы слот репликации НЕ был задан.
          type: boolean
        initialLoadParallelism:
          description: >-
            Количество таблиц, синхронизируемых параллельно во время начальной
            загрузки.
          type: number
        publicationName:
          description: Имя публикации, используемой для репликации.
          type: string
        pullBatchSize:
          description: Количество строк, извлекаемых в каждом батче.
          type: number
        replicationMode:
          description: Режим репликации для пайпа.
          enum:
            - cdc
            - snapshot
            - cdc_only
          type: string
        replicationSlotName:
          description: Имя слота репликации, используемого для репликации.
          type: string
        snapshotNumRowsPerPartition:
          description: Количество строк в снимке для каждой партиции.
          type: number
        snapshotNumberOfParallelTables:
          description: Количество таблиц, для которых снимок создаётся параллельно.
          type: number
        syncIntervalSeconds:
          description: Интервал в секундах для синхронизации данных из Postgres.
          type: number
    ClickPipePostgresPipeTableMapping:
      properties:
        excludedColumns:
          description: Столбцы, которые нужно исключить из целевой таблицы.
          items:
            type: string
          type: array
        sortingKeys:
          description: >-
            Упорядоченный список столбцов, используемых в качестве ключа
            сортировки целевой таблицы.
          items:
            type: string
          type: array
        sourceSchemaName:
          description: Имя исходной схемы.
          type: string
        sourceTable:
          description: Имя исходной таблицы.
          type: string
        tableEngine:
          description: Движок таблицы для целевой таблицы.
          enum:
            - MergeTree
            - ReplacingMergeTree
            - 'Null'
          type: string
        targetTable:
          description: Имя целевой таблицы.
          type: string
        useCustomSortingKey:
          description: >-
            Следует ли использовать пользовательский ключ сортировки для целевой
            таблицы.
          type: boolean
  securitySchemes:
    basicAuth:
      description: >-
        Используйте идентификатор ключа и секрет ключа, полученные в консоли
        ClickHouse Cloud: https://clickhouse.com/docs/cloud/manage/openapi
      scheme: basic
      type: http

````