ClickPipe の設定を取得

このendpointはベータです。 APIコントラクトは安定しており、今後互換性を損なう変更が行われる予定はありません。

指定したClickPipeのadvanced settingsを返します。

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

ClickPipe の設定を取得

cURL

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings \
  --header 'Authorization: Basic <encoded-value>'

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 console で取得した key ID と key secret を使用してください: https://clickhouse.com/docs/cloud/manage/openapi

パスパラメータ

organizationId · string<uuid> · 必須

serviceを所有する組織のID。

serviceId · string<uuid> · 必須

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

clickPipeId · string<uuid> · 必須

設定の取得対象となる ClickPipe の ID。

レスポンス

200

application/json

成功レスポンス

requestId · string<uuid>

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

result · object

Show child attributes

status · number

HTTP ステータスコード。

例:

200