Update ClickPipe settings - ClickHouse Documentation

PUT

organizations

{organizationId}

services

{serviceId}

clickpipes

{clickPipeId}

settings

Update ClickPipe settings

curl --request PUT \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "streaming_max_insert_wait_ms": 5000,
  "object_storage_concurrency": 1,
  "object_storage_polling_interval_ms": 30000,
  "object_storage_max_insert_bytes": 10737418240,
  "object_storage_max_file_count": 100,
  "clickhouse_max_threads": 8,
  "clickhouse_max_insert_threads": 1,
  "clickhouse_min_insert_block_size_bytes": 1073741824,
  "clickhouse_max_download_threads": 4,
  "clickhouse_parallel_distributed_insert_select": 2,
  "object_storage_use_cluster_function": true,
  "clickhouse_parallel_view_processing": false
}
'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings"

payload = {
    "streaming_max_insert_wait_ms": 5000,
    "object_storage_concurrency": 1,
    "object_storage_polling_interval_ms": 30000,
    "object_storage_max_insert_bytes": 10737418240,
    "object_storage_max_file_count": 100,
    "clickhouse_max_threads": 8,
    "clickhouse_max_insert_threads": 1,
    "clickhouse_min_insert_block_size_bytes": 1073741824,
    "clickhouse_max_download_threads": 4,
    "clickhouse_parallel_distributed_insert_select": 2,
    "object_storage_use_cluster_function": True,
    "clickhouse_parallel_view_processing": False
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    streaming_max_insert_wait_ms: 5000,
    object_storage_concurrency: 1,
    object_storage_polling_interval_ms: 30000,
    object_storage_max_insert_bytes: 10737418240,
    object_storage_max_file_count: 100,
    clickhouse_max_threads: 8,
    clickhouse_max_insert_threads: 1,
    clickhouse_min_insert_block_size_bytes: 1073741824,
    clickhouse_max_download_threads: 4,
    clickhouse_parallel_distributed_insert_select: 2,
    object_storage_use_cluster_function: true,
    clickhouse_parallel_view_processing: false
  })
};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'streaming_max_insert_wait_ms' => 5000,
    'object_storage_concurrency' => 1,
    'object_storage_polling_interval_ms' => 30000,
    'object_storage_max_insert_bytes' => 10737418240,
    'object_storage_max_file_count' => 100,
    'clickhouse_max_threads' => 8,
    'clickhouse_max_insert_threads' => 1,
    'clickhouse_min_insert_block_size_bytes' => 1073741824,
    'clickhouse_max_download_threads' => 4,
    'clickhouse_parallel_distributed_insert_select' => 2,
    'object_storage_use_cluster_function' => true,
    'clickhouse_parallel_view_processing' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings"

	payload := strings.NewReader("{\n  \"streaming_max_insert_wait_ms\": 5000,\n  \"object_storage_concurrency\": 1,\n  \"object_storage_polling_interval_ms\": 30000,\n  \"object_storage_max_insert_bytes\": 10737418240,\n  \"object_storage_max_file_count\": 100,\n  \"clickhouse_max_threads\": 8,\n  \"clickhouse_max_insert_threads\": 1,\n  \"clickhouse_min_insert_block_size_bytes\": 1073741824,\n  \"clickhouse_max_download_threads\": 4,\n  \"clickhouse_parallel_distributed_insert_select\": 2,\n  \"object_storage_use_cluster_function\": true,\n  \"clickhouse_parallel_view_processing\": false\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"streaming_max_insert_wait_ms\": 5000,\n  \"object_storage_concurrency\": 1,\n  \"object_storage_polling_interval_ms\": 30000,\n  \"object_storage_max_insert_bytes\": 10737418240,\n  \"object_storage_max_file_count\": 100,\n  \"clickhouse_max_threads\": 8,\n  \"clickhouse_max_insert_threads\": 1,\n  \"clickhouse_min_insert_block_size_bytes\": 1073741824,\n  \"clickhouse_max_download_threads\": 4,\n  \"clickhouse_parallel_distributed_insert_select\": 2,\n  \"object_storage_use_cluster_function\": true,\n  \"clickhouse_parallel_view_processing\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"streaming_max_insert_wait_ms\": 5000,\n  \"object_storage_concurrency\": 1,\n  \"object_storage_polling_interval_ms\": 30000,\n  \"object_storage_max_insert_bytes\": 10737418240,\n  \"object_storage_max_file_count\": 100,\n  \"clickhouse_max_threads\": 8,\n  \"clickhouse_max_insert_threads\": 1,\n  \"clickhouse_min_insert_block_size_bytes\": 1073741824,\n  \"clickhouse_max_download_threads\": 4,\n  \"clickhouse_parallel_distributed_insert_select\": 2,\n  \"object_storage_use_cluster_function\": true,\n  \"clickhouse_parallel_view_processing\": false\n}"

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "streaming_max_insert_wait_ms": 5000,
    "object_storage_concurrency": 1,
    "object_storage_polling_interval_ms": 30000,
    "object_storage_max_insert_bytes": 10737418240,
    "object_storage_max_file_count": 100,
    "clickhouse_max_threads": 8,
    "clickhouse_max_insert_threads": 1,
    "clickhouse_min_insert_block_size_bytes": 1073741824,
    "clickhouse_max_download_threads": 4,
    "clickhouse_parallel_distributed_insert_select": 2,
    "object_storage_use_cluster_function": true,
    "clickhouse_parallel_view_processing": false
  }
}

{
  "status": 400,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "status": 500,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Update the advanced settings for the specified ClickPipe. Send key-value pairs where values can be strings, numbers, or booleans.

授权

Authorization

string

header

必填

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

路径参数

organizationId

string<uuid>

必填

ID of the organization that owns the service.

serviceId

string<uuid>

必填

ID of the service that owns the ClickPipe.

clickPipeId

string<uuid>

必填

ID of the ClickPipe to update settings for.

请求体

application/json

streaming_max_insert_wait_ms

integer | null

Streaming max insert wait time. Configures the max wait period before inserting data into the ClickHouse.

必填范围: 500 <= x <= 60000

示例:

5000

object_storage_concurrency

integer | null

Object storage concurrency. Number of concurrent file processing threads

必填范围: 1 <= x <= 35

示例:

1

object_storage_polling_interval_ms

integer | null

Object storage polling interval. Configures the refresh interval for querying continuous ingest for new object storage data

必填范围: 100 <= x <= 3600000

示例:

30000

object_storage_max_insert_bytes

integer | null

Max insert bytes. Number of bytes to process in a single insert batch

必填范围: 10485760 <= x <= 53687091200

示例:

10737418240

object_storage_max_file_count

integer | null

Max file count. Maximum number of files to process in a single insert batch

必填范围: 1 <= x <= 10000

示例:

100

clickhouse_max_threads

integer | null

Max threads. Maximum number of concurrent threads for file processing

必填范围: 0 <= x <= 64

示例:

8

clickhouse_max_insert_threads

integer | null

Max insert threads. Maximum number of concurrent insert threads

必填范围: 0 <= x <= 16

示例:

1

clickhouse_min_insert_block_size_bytes

integer | null

Min insert block size bytes. Minimum size of data block for insert (in bytes)

必填范围: 0 <= x <= 10737418240

示例:

1073741824

clickhouse_max_download_threads

integer | null

Max download threads. Maximum number of concurrent download threads

必填范围: 0 <= x <= 32

示例:

4

clickhouse_parallel_distributed_insert_select

integer | null

Parallel distributed insert select. Parallel distributed insert select setting

必填范围: 0 <= x <= 2

示例:

2

object_storage_use_cluster_function

boolean | null

use cluster function. Whether to use ClickHouse cluster function for distributed processing

示例:

true

clickhouse_parallel_view_processing

boolean | null

parallel view processing. Whether to enable pushing to attached views concurrently instead of sequentially

示例:

false

响应

Successful response

status

number

HTTP status code.

示例:

200

requestId

string<uuid>

Unique id assigned to every request. UUIDv4

result

object

Show child attributes

最后修改于 2026年7月24日

Discover ClickPipe source schema**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. <br /><br /> Infers the schema (field names and ClickHouse data types) of a streaming ClickPipe source without creating a pipe. Supported for Kafka, Kinesis sources.

Update ClickPipe settings

curl --request PUT \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "streaming_max_insert_wait_ms": 5000,
  "object_storage_concurrency": 1,
  "object_storage_polling_interval_ms": 30000,
  "object_storage_max_insert_bytes": 10737418240,
  "object_storage_max_file_count": 100,
  "clickhouse_max_threads": 8,
  "clickhouse_max_insert_threads": 1,
  "clickhouse_min_insert_block_size_bytes": 1073741824,
  "clickhouse_max_download_threads": 4,
  "clickhouse_parallel_distributed_insert_select": 2,
  "object_storage_use_cluster_function": true,
  "clickhouse_parallel_view_processing": false
}
'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings"

payload = {
    "streaming_max_insert_wait_ms": 5000,
    "object_storage_concurrency": 1,
    "object_storage_polling_interval_ms": 30000,
    "object_storage_max_insert_bytes": 10737418240,
    "object_storage_max_file_count": 100,
    "clickhouse_max_threads": 8,
    "clickhouse_max_insert_threads": 1,
    "clickhouse_min_insert_block_size_bytes": 1073741824,
    "clickhouse_max_download_threads": 4,
    "clickhouse_parallel_distributed_insert_select": 2,
    "object_storage_use_cluster_function": True,
    "clickhouse_parallel_view_processing": False
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    streaming_max_insert_wait_ms: 5000,
    object_storage_concurrency: 1,
    object_storage_polling_interval_ms: 30000,
    object_storage_max_insert_bytes: 10737418240,
    object_storage_max_file_count: 100,
    clickhouse_max_threads: 8,
    clickhouse_max_insert_threads: 1,
    clickhouse_min_insert_block_size_bytes: 1073741824,
    clickhouse_max_download_threads: 4,
    clickhouse_parallel_distributed_insert_select: 2,
    object_storage_use_cluster_function: true,
    clickhouse_parallel_view_processing: false
  })
};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'streaming_max_insert_wait_ms' => 5000,
    'object_storage_concurrency' => 1,
    'object_storage_polling_interval_ms' => 30000,
    'object_storage_max_insert_bytes' => 10737418240,
    'object_storage_max_file_count' => 100,
    'clickhouse_max_threads' => 8,
    'clickhouse_max_insert_threads' => 1,
    'clickhouse_min_insert_block_size_bytes' => 1073741824,
    'clickhouse_max_download_threads' => 4,
    'clickhouse_parallel_distributed_insert_select' => 2,
    'object_storage_use_cluster_function' => true,
    'clickhouse_parallel_view_processing' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings"

	payload := strings.NewReader("{\n  \"streaming_max_insert_wait_ms\": 5000,\n  \"object_storage_concurrency\": 1,\n  \"object_storage_polling_interval_ms\": 30000,\n  \"object_storage_max_insert_bytes\": 10737418240,\n  \"object_storage_max_file_count\": 100,\n  \"clickhouse_max_threads\": 8,\n  \"clickhouse_max_insert_threads\": 1,\n  \"clickhouse_min_insert_block_size_bytes\": 1073741824,\n  \"clickhouse_max_download_threads\": 4,\n  \"clickhouse_parallel_distributed_insert_select\": 2,\n  \"object_storage_use_cluster_function\": true,\n  \"clickhouse_parallel_view_processing\": false\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"streaming_max_insert_wait_ms\": 5000,\n  \"object_storage_concurrency\": 1,\n  \"object_storage_polling_interval_ms\": 30000,\n  \"object_storage_max_insert_bytes\": 10737418240,\n  \"object_storage_max_file_count\": 100,\n  \"clickhouse_max_threads\": 8,\n  \"clickhouse_max_insert_threads\": 1,\n  \"clickhouse_min_insert_block_size_bytes\": 1073741824,\n  \"clickhouse_max_download_threads\": 4,\n  \"clickhouse_parallel_distributed_insert_select\": 2,\n  \"object_storage_use_cluster_function\": true,\n  \"clickhouse_parallel_view_processing\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"streaming_max_insert_wait_ms\": 5000,\n  \"object_storage_concurrency\": 1,\n  \"object_storage_polling_interval_ms\": 30000,\n  \"object_storage_max_insert_bytes\": 10737418240,\n  \"object_storage_max_file_count\": 100,\n  \"clickhouse_max_threads\": 8,\n  \"clickhouse_max_insert_threads\": 1,\n  \"clickhouse_min_insert_block_size_bytes\": 1073741824,\n  \"clickhouse_max_download_threads\": 4,\n  \"clickhouse_parallel_distributed_insert_select\": 2,\n  \"object_storage_use_cluster_function\": true,\n  \"clickhouse_parallel_view_processing\": false\n}"

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "streaming_max_insert_wait_ms": 5000,
    "object_storage_concurrency": 1,
    "object_storage_polling_interval_ms": 30000,
    "object_storage_max_insert_bytes": 10737418240,
    "object_storage_max_file_count": 100,
    "clickhouse_max_threads": 8,
    "clickhouse_max_insert_threads": 1,
    "clickhouse_min_insert_block_size_bytes": 1073741824,
    "clickhouse_max_download_threads": 4,
    "clickhouse_parallel_distributed_insert_select": 2,
    "object_storage_use_cluster_function": true,
    "clickhouse_parallel_view_processing": false
  }
}

{
  "status": 400,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "status": 500,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}