ClickPipe の設定を更新

この endpoint はベータです。 API コントラクトは安定しており、今後破壊的変更が加えられる予定はありません。

指定した ClickPipe の詳細設定を更新します。値には文字列、数値、またはブール値を指定したキー・バリューのペアを送信してください。

PUT /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings

ClickPipe の設定を更新

cURL

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

200

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

承認

Authorization · string · header · 必須

ClickHouse Cloud コンソールで取得した key ID と key secret を使用してください: https://clickhouse.com/docs/cloud/manage/openapi

パスパラメータ

organizationId · string<uuid> · 必須

サービスを所有する組織の ID。

serviceId · string<uuid> · 必須

ClickPipe を所有するサービスの ID。

clickPipeId · string<uuid> · 必須

設定を更新する対象の ClickPipe の ID。

ボディ

application/json

clickhouse_max_download_threads · integer | null

最大ダウンロードスレッド数。同時実行するダウンロードスレッドの最大数。

必須範囲: 0 <= x <= 32

例:

4

clickhouse_max_insert_threads · integer | null

最大挿入スレッド数。同時実行する挿入スレッドの最大数。

必須範囲: 0 <= x <= 16

例:

1

clickhouse_max_threads · integer | null

最大スレッド数。ファイル処理を同時実行するスレッドの最大数。

必須範囲: 0 <= x <= 64

例:

8

clickhouse_min_insert_block_size_bytes · integer | null

最小挿入ブロックサイズ（バイト）。挿入時のデータブロックの最小サイズ（バイト単位）。

必須範囲: 0 <= x <= 10737418240

例:

1073741824

clickhouse_parallel_distributed_insert_select · integer | null

parallel distributed insert select。parallel distributed insert select の設定。

必須範囲: 0 <= x <= 2

例:

2

clickhouse_parallel_view_processing · boolean | null

並列ビュー処理。attached ビューへのプッシュを順次ではなく同時実行で有効にするかどうか。

例:

false

object_storage_concurrency · integer | null

オブジェクトストレージの同時実行数。ファイル処理を同時実行するスレッド数。

必須範囲: 1 <= x <= 35

例:

1

object_storage_max_file_count · integer | null

最大ファイル数。1 回の挿入バッチで処理するファイルの最大数。

必須範囲: 1 <= x <= 10000

例:

100

object_storage_max_insert_bytes · integer | null

最大挿入バイト数。1 回の挿入バッチで処理するバイト数。

必須範囲: 10485760 <= x <= 53687091200

例:

10737418240

object_storage_polling_interval_ms · integer | null

オブジェクトストレージのポーリング間隔。新しいオブジェクトストレージデータを継続的に取り込むためのクエリの更新間隔を設定します。

必須範囲: 100 <= x <= 3600000

例:

30000

object_storage_use_cluster_function · boolean | null

cluster 関数を使用。分散処理に ClickHouse の cluster 関数を使用するかどうか。

例:

true

streaming_max_insert_wait_ms · integer | null

ストリーミングの最大挿入待機時間。データを ClickHouse に挿入する前の最大待機時間を設定します。

必須範囲: 500 <= x <= 60000

例:

5000

レスポンス

200

application/json

正常なレスポンス

requestId · string<uuid>

各リクエストに割り当てられる一意の ID。UUIDv4

result · object

Show child attributes

status · number

HTTP ステータスコード。

例:

200