Mettre à jour les paramètres du ClickPipe

PUT

organizations

{organizationId}

services

{serviceId}

clickpipes

{clickPipeId}

settings

Mettre à jour les paramètres du ClickPipe

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

import requests

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

payload = {
    "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
}
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({
    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
  })
};

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([
    '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
  ]),
  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  \"clickhouse_max_download_threads\": 4,\n  \"clickhouse_max_insert_threads\": 1,\n  \"clickhouse_max_threads\": 8,\n  \"clickhouse_min_insert_block_size_bytes\": 1073741824,\n  \"clickhouse_parallel_distributed_insert_select\": 2,\n  \"clickhouse_parallel_view_processing\": false,\n  \"object_storage_concurrency\": 1,\n  \"object_storage_max_file_count\": 100,\n  \"object_storage_max_insert_bytes\": 10737418240,\n  \"object_storage_polling_interval_ms\": 30000,\n  \"object_storage_use_cluster_function\": true,\n  \"streaming_max_insert_wait_ms\": 5000\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  \"clickhouse_max_download_threads\": 4,\n  \"clickhouse_max_insert_threads\": 1,\n  \"clickhouse_max_threads\": 8,\n  \"clickhouse_min_insert_block_size_bytes\": 1073741824,\n  \"clickhouse_parallel_distributed_insert_select\": 2,\n  \"clickhouse_parallel_view_processing\": false,\n  \"object_storage_concurrency\": 1,\n  \"object_storage_max_file_count\": 100,\n  \"object_storage_max_insert_bytes\": 10737418240,\n  \"object_storage_polling_interval_ms\": 30000,\n  \"object_storage_use_cluster_function\": true,\n  \"streaming_max_insert_wait_ms\": 5000\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  \"clickhouse_max_download_threads\": 4,\n  \"clickhouse_max_insert_threads\": 1,\n  \"clickhouse_max_threads\": 8,\n  \"clickhouse_min_insert_block_size_bytes\": 1073741824,\n  \"clickhouse_parallel_distributed_insert_select\": 2,\n  \"clickhouse_parallel_view_processing\": false,\n  \"object_storage_concurrency\": 1,\n  \"object_storage_max_file_count\": 100,\n  \"object_storage_max_insert_bytes\": 10737418240,\n  \"object_storage_polling_interval_ms\": 30000,\n  \"object_storage_use_cluster_function\": true,\n  \"streaming_max_insert_wait_ms\": 5000\n}"

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

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "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
  },
  "status": 200
}

{
  "error": "<string>",
  "status": 400
}

Autorisations

Authorization

string

header

requis

Utilisez l’ID de la clé et le secret de la clé obtenus dans la ClickHouse Cloud console : https://clickhouse.com/docs/cloud/manage/openapi

Paramètres de chemin

organizationId

string<uuid>

requis

ID de l’organisation propriétaire du service.

serviceId

string<uuid>

requis

ID du service propriétaire du ClickPipe.

clickPipeId

string<uuid>

requis

ID du ClickPipe dont il faut mettre à jour les paramètres.

Corps

application/json

clickhouse_max_download_threads

integer | null

Nombre maximal de threads de téléchargement. Nombre maximal de threads de téléchargement concurrents

Plage requise: 0 <= x <= 32

Exemple:

4

clickhouse_max_insert_threads

integer | null

Nombre maximal de threads d’insertion. Nombre maximal de threads d’insertion concurrents

Plage requise: 0 <= x <= 16

Exemple:

1

clickhouse_max_threads

integer | null

Nombre maximal de threads. Nombre maximal de threads concurrents pour le traitement des fichiers

Plage requise: 0 <= x <= 64

Exemple:

8

clickhouse_min_insert_block_size_bytes

integer | null

Taille minimale du bloc d’insertion en octets. Taille minimale du bloc de données pour l’insertion (en octets)

Plage requise: 0 <= x <= 10737418240

Exemple:

1073741824

clickhouse_parallel_distributed_insert_select

integer | null

Insertion SELECT distribuée en parallèle. Paramètre d’insertion SELECT distribuée en parallèle

Plage requise: 0 <= x <= 2

Exemple:

2

clickhouse_parallel_view_processing

boolean | null

traitement parallèle des vues. Indique s’il faut activer l’envoi concurrent vers les vues attachées plutôt que séquentiel

Exemple:

false

object_storage_concurrency

integer | null

Concurrence du stockage d’objets. Nombre de threads concurrents pour le traitement des fichiers

Plage requise: 1 <= x <= 35

Exemple:

1

object_storage_max_file_count

integer | null

Nombre maximal de fichiers. Nombre maximal de fichiers à traiter dans un seul lot d’insertion

Plage requise: 1 <= x <= 10000

Exemple:

100

object_storage_max_insert_bytes

integer | null

Nombre maximal d’octets par insertion. Nombre d’octets à traiter dans un seul lot d’insertion

Plage requise: 10485760 <= x <= 53687091200

Exemple:

10737418240

object_storage_polling_interval_ms

integer | null

Intervalle d’interrogation du stockage d’objets. Configure l’intervalle d’actualisation pour interroger l’ingestion continue à la recherche de nouvelles données dans le stockage d’objets

Plage requise: 100 <= x <= 3600000

Exemple:

30000

object_storage_use_cluster_function

boolean | null

utiliser la fonction cluster. Indique s’il faut utiliser la fonction cluster de ClickHouse pour le traitement distribué

Exemple:

true

streaming_max_insert_wait_ms

integer | null

Temps d’attente maximal avant insertion en streaming. Configure le délai d’attente maximal avant l’insertion des données dans ClickHouse.

Plage requise: 500 <= x <= 60000

Exemple:

5000

Réponse

Réponse réussie

requestId

string<uuid>

ID unique attribué à chaque requête. UUIDv4

result

object

Show child attributes

status

number

Code d’état HTTP.

Exemple:

200

Dernière modification le 2 juillet 2026

Mettre à jour l’état du ClickPipe**Ce endpoint est en bêta.** Le contrat d’API est stable et aucun breaking change n’est attendu à l’avenir. <br /><br /> Démarrez, arrêtez ou resynchronisez le ClickPipe. L’arrêt d’un ClickPipe interrompt le processus d’ingestion, quel que soit son état. Le démarrage est autorisé pour les ClickPipes dans l’état "Stopped" ou "Failed". La resynchronisation s’applique uniquement aux pipes Postgres et peut être effectuée depuis n’importe quel état.

Mettre à jour les paramètres du ClickPipe

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

import requests

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

payload = {
    "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
}
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({
    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
  })
};

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([
    '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
  ]),
  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  \"clickhouse_max_download_threads\": 4,\n  \"clickhouse_max_insert_threads\": 1,\n  \"clickhouse_max_threads\": 8,\n  \"clickhouse_min_insert_block_size_bytes\": 1073741824,\n  \"clickhouse_parallel_distributed_insert_select\": 2,\n  \"clickhouse_parallel_view_processing\": false,\n  \"object_storage_concurrency\": 1,\n  \"object_storage_max_file_count\": 100,\n  \"object_storage_max_insert_bytes\": 10737418240,\n  \"object_storage_polling_interval_ms\": 30000,\n  \"object_storage_use_cluster_function\": true,\n  \"streaming_max_insert_wait_ms\": 5000\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  \"clickhouse_max_download_threads\": 4,\n  \"clickhouse_max_insert_threads\": 1,\n  \"clickhouse_max_threads\": 8,\n  \"clickhouse_min_insert_block_size_bytes\": 1073741824,\n  \"clickhouse_parallel_distributed_insert_select\": 2,\n  \"clickhouse_parallel_view_processing\": false,\n  \"object_storage_concurrency\": 1,\n  \"object_storage_max_file_count\": 100,\n  \"object_storage_max_insert_bytes\": 10737418240,\n  \"object_storage_polling_interval_ms\": 30000,\n  \"object_storage_use_cluster_function\": true,\n  \"streaming_max_insert_wait_ms\": 5000\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  \"clickhouse_max_download_threads\": 4,\n  \"clickhouse_max_insert_threads\": 1,\n  \"clickhouse_max_threads\": 8,\n  \"clickhouse_min_insert_block_size_bytes\": 1073741824,\n  \"clickhouse_parallel_distributed_insert_select\": 2,\n  \"clickhouse_parallel_view_processing\": false,\n  \"object_storage_concurrency\": 1,\n  \"object_storage_max_file_count\": 100,\n  \"object_storage_max_insert_bytes\": 10737418240,\n  \"object_storage_polling_interval_ms\": 30000,\n  \"object_storage_use_cluster_function\": true,\n  \"streaming_max_insert_wait_ms\": 5000\n}"

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

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "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
  },
  "status": 200
}

{
  "error": "<string>",
  "status": 400
}