List UDF attachments | ClickHouse Docs

GET/v1/organizations/{organizationId}/udfs/{functionName}/attachments

Returns the current service attachments for a UDF, with at most one attachment per service.

Permission

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

Authorizations

Authorizationstringheaderrequired
Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path parameters

organizationIdstringrequired
ID of the requested organization.

format: uuid, 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)$
functionNamestringrequired
Name of the UDF.

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

Query parameters

cursoroptionalstring
Cursor returned as nextCursor on the previous page.
limitoptionalinteger
Maximum number of records to return per page. Defaults to 100. Maximum is 100.

maximum: 100
Default: 100

Response

JSON

200

Successful response.

JSON

resultarray ofobjectrequired
Current service attachments for the UDF in this page.
4 properties
- functionNamestringrequired
  Name of the UDF.
- serviceIdstringrequired
  ID of the attached service.
  
  format: uuid, 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)$
- statusdeployedordeprovisioningorerrororprovisioningorstandbyrequired
  Current attachment lifecycle state.
- versionintegerrequired
  Attached UDF version.
  
  Example: 1
limitintegerrequired
Maximum number of results returned in this page.
totalCountintegerornullrequired
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.
2 variants
One of the following:
integer
null
nextCursorstringornullrequired
Cursor for the next page, to be sent as the cursor query parameter. Null on the last page.
2 variants
One of the following:
string
null
statusintegerrequired
HTTP status code.

Example: 200
requestIdstringrequired
Unique id assigned to every request. UUIDv4

format: uuid, 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)$

List UDF attachments

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/udfs/string/attachments \
  --header 'Authorization: Basic <token>'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/udfs/string/attachments';
const options = {method: 'GET', headers: {Authorization: 'Basic <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/udfs/string/attachments"

headers = {"Authorization": "Basic <token>"}

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

print(response.text)

Response example

{
  "result": [
    {
      "functionName": "string",
      "serviceId": "8f8bb40f-b96b-40fe-9064-5031fbe483f9",
      "status": "deployed",
      "version": 1
    }
  ],
  "limit": 0,
  "totalCount": 0,
  "nextCursor": "string",
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "error": "string",
  "issues": [
    {
      "path": [
        "string"
      ],
      "code": "string",
      "message": "string"
    }
  ],
  "status": 400,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "error": "string",
  "status": 404,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "error": "string",
  "status": 500,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "property1": null,
  "property2": null
}