跳转到主要内容
POST
创建密钥

授权

Authorization
string
header
必填

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

路径参数

organizationId
string<uuid>
必填

将拥有该密钥的 organization 的 ID。

请求体

application/json
expireAt
string<date-time> | null

key 的过期时间戳。如果未提供、为 null 或为空,则该 key 永不过期。ISO-8601。

hashData
object
ipAccessList
object[]

允许使用此 key 访问 API 的 IP 地址列表

name
string

key 的名称。

roles
enum<string>[]

分配给该 key 的 role 列表。至少包含 1 个元素。

可用选项:
admin,
developer,
query_endpoints
state
enum<string>

key 的初始状态:'enabled'、'disabled'。如果未提供,则新 key 的状态为 'enabled'。

可用选项:
enabled,
disabled

响应

成功响应

requestId
string<uuid>

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

result
object
status
number

HTTP 状态码。

示例:

200

最后修改于 2026年7月2日