获取可用的组织列表 - ClickHouse Documentation

GET

organizations

获取可用的组织列表

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

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": [
    {
      "byocConfig": [
        {
          "accountName": "<string>",
          "id": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "privateEndpoints": [
        {
          "description": "<string>",
          "id": "<string>"
        }
      ]
    }
  ],
  "status": 200
}

授权

Authorization

string

header

必填

使用从 ClickHouse Cloud 控制台获取的 key ID 和 key secret：https://clickhouse.com/docs/cloud/manage/openapi

响应

成功响应

requestId

string<uuid>

分配给每个请求的唯一 ID。UUIDv4

result

object[]

Show child attributes

status

number

HTTP 状态码。

示例:

200

最后修改于 2026年6月29日

获取组织详情返回单个组织的详细信息。要获取这些详细信息，auth key 必须属于该组织。

获取可用的组织列表

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

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": [
    {
      "byocConfig": [
        {
          "accountName": "<string>",
          "id": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "privateEndpoints": [
        {
          "description": "<string>",
          "id": "<string>"
        }
      ]
    }
  ],
  "status": 200
}