Skip to main content
POST
Create UDF
Creates a new UDF. See User-defined functions in Cloud.

Permission

The API key must have the control-plane:organization:manage permission.

인증

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 requested organization.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$

본문

application/json
uploadId
string<uuid>
필수

Identifier of the uploaded source archive.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
runtime
enum<string>
필수
사용 가능한 옵션:
python3.11,
native
arguments
object[]
필수
returnType
string
필수
type
string
필수
Allowed value: "executable"
functionName
string
필수
Pattern: ^[A-Za-z][A-Za-z0-9_]*$
returnName
string | null
Pattern: ^[A-Za-z][A-Za-z0-9_]*$
commandReadTimeout
integer
기본값:10000
commandWriteTimeout
integer
기본값:10000
memoryLimitMib
integer | null
필수 범위: 1 <= x <= 1048576
sendChunkHeader
boolean
기본값:false
deterministic
boolean
기본값:false

Marks the UDF as deterministic so ClickHouse can reuse cached query results. Only set this when the UDF always returns the same result for the same arguments.

format
string
기본값:TabSeparated
sandboxType
enum<string>
기본값:basic
사용 가능한 옵션:
basic,
netenable
sandboxVersion
enum<string>
기본값:v2
사용 가능한 옵션:
v1,
v2,
v3
poolSize
null

Always null — an executable UDF has no command pool.

maxCommandExecutionTime
integer | null
기본값:10
필수 범위: x > 0

응답

UDF created and building.

status
integer
필수

HTTP status code.

예시:

201

requestId
string<uuid>
필수

Unique id assigned to every request. UUIDv4

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
result
object
필수
마지막 수정일 2026년 10월 3일