Skip to main content
PATCH
Update ClickPipe
Update the specified ClickPipe.

授权

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 to create the ClickPipe for.

clickPipeId
string<uuid>
必填

ID of the requested ClickPipe.

请求体

application/json
name
string | null

Name of the ClickPipe.

source
object | null
destination
object | null
fieldMappings
object[]

Field mappings of the ClickPipe. This will not update the table schema, only the ClickPipe configuration.

settings
object | null

响应

Successful response

status
number

HTTP status code.

示例:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object
最后修改于 2026年7月24日