Skip to main content
POST
Create UDF version
Consumes a source archive, assigns a version, and starts the UDF build. Optional configuration fields omitted from the request use the defaults documented in the request schema; values are not inherited from the previous version. Retry by requesting a new upload URL and re-uploading.

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)$
functionName
string
مطلوب

Name of the UDF.

Pattern: ^[A-Za-z][A-Za-z0-9_]*$

الجسم

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"
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 version 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
مطلوب
آخر تعديل في ٣ أكتوبر ٢٠٢٦