List UDFs

GET

organizations

{organizationId}

udfs

List UDFs

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

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "result": [
    {
      "functionName": "<string>",
      "version": 1,
      "status": "building",
      "runtime": "python3.11",
      "type": "executable",
      "arguments": [
        {
          "name": "<string>",
          "type": "<string>"
        }
      ],
      "returnType": "<string>",
      "returnName": "<string>",
      "poolSize": 1,
      "commandReadTimeout": 123,
      "commandWriteTimeout": 123,
      "maxCommandExecutionTime": 1,
      "memoryLimitMib": 524288,
      "sendChunkHeader": true,
      "deterministic": true,
      "format": "<string>",
      "sandboxType": "basic",
      "sandboxVersion": "v1",
      "error": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 123,
  "totalCount": 123,
  "nextCursor": "<string>",
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": "<string>",
  "status": 400,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "status": 500,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Returns the latest version of each UDF in the organization.

Permission

The API key must have the control-plane:organization:view 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)$

查询参数

cursor

string

Cursor returned as nextCursor on the previous page.

limit

integer

默认值:100

Maximum number of records to return per page. Defaults to 100. Maximum is 100.

必填范围: x <= 100

响应

Successful response.

result

object[]

必填

Latest version of each UDF in the organization.

Show child attributes

limit

integer

必填

Maximum number of results returned in this page.

totalCount

integer | null

必填

Total number of results across all pages. It has only informative value, thus is not guaranteed and it is provided on a best-effort basis. Null if the total count is unknown.

nextCursor

string | null

必填

Cursor for the next page, to be sent as the cursor query parameter. Null on the last page.

status

integer

必填

HTTP status code.

示例:

200

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)$

最后修改于 2026年10月3日

List UDFs

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

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "result": [
    {
      "functionName": "<string>",
      "version": 1,
      "status": "building",
      "runtime": "python3.11",
      "type": "executable",
      "arguments": [
        {
          "name": "<string>",
          "type": "<string>"
        }
      ],
      "returnType": "<string>",
      "returnName": "<string>",
      "poolSize": 1,
      "commandReadTimeout": 123,
      "commandWriteTimeout": 123,
      "maxCommandExecutionTime": 1,
      "memoryLimitMib": 524288,
      "sendChunkHeader": true,
      "deterministic": true,
      "format": "<string>",
      "sandboxType": "basic",
      "sandboxVersion": "v1",
      "error": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 123,
  "totalCount": 123,
  "nextCursor": "<string>",
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": "<string>",
  "status": 400,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "status": 500,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

入门

服务与基础设施

自备 Cloud

数据与集成

连接与查询

访问管理

安全与合规

监控与备份

AI 工具与智能体

Cloud API

账单

支持

Permission

授权

路径参数

查询参数

响应

​Permission

授权

路径参数

查询参数

响应

Permission