创建密钥

创建新的 API key。

POST /v1/organizations/{organizationId}/keys

创建密钥

cURL

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expireAt": "2023-11-07T05:31:56Z",
  "hashData": {
    "keyIdHash": "<string>",
    "keyIdSuffix": "<string>",
    "keySecretHash": "<string>"
  },
  "ipAccessList": [
    {
      "description": "<string>",
      "source": "<string>"
    }
  ],
  "name": "<string>",
  "roles": []
}
'

200

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "key": {
      "createdAt": "2023-11-07T05:31:56Z",
      "expireAt": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ipAccessList": [
        {
          "description": "<string>",
          "source": "<string>"
        }
      ],
      "keySuffix": "<string>",
      "name": "<string>",
      "roles": [],
      "usedAt": "2023-11-07T05:31:56Z"
    },
    "keyId": "<string>",
    "keySecret": "<string>"
  },
  "status": 200
}

授权

Authorization · string · header · 必填

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

路径参数

organizationId · string<uuid> · 必填

将拥有该 key 的组织 ID。

请求体

application/json

expireAt · string<date-time> | null

key 的过期时间戳。如果不存在、为 null 或为空，则该 key 永不过期。ISO-8601。

hashData · object

Show child attributes

ipAccessList · object[]

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

Show child attributes

name · string

key 的名称。

roles · enum<string>[]

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

可用选项: admin, developer, query_endpoints

state · enum<string>

key 的初始状态：'enabled'、'disabled'。如果未提供，则新 key 将为 'enabled'。

可用选项: enabled, disabled

响应

200

application/json

成功响应

requestId · string<uuid>

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

result · object

Show child attributes

status · number

HTTP 状态码。

示例:

200