创建密钥

创建新的 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": []
}
'

import requests

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

payload = {
    "expireAt": "2023-11-07T05:31:56Z",
    "hashData": {
        "keyIdHash": "<string>",
        "keyIdSuffix": "<string>",
        "keySecretHash": "<string>"
    },
    "ipAccessList": [
        {
            "description": "<string>",
            "source": "<string>"
        }
    ],
    "name": "<string>",
    "roles": []
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    expireAt: '2023-11-07T05:31:56Z',
    hashData: {keyIdHash: '<string>', keyIdSuffix: '<string>', keySecretHash: '<string>'},
    ipAccessList: [{description: '<string>', source: '<string>'}],
    name: '<string>',
    roles: []
  })
};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys', 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}/keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'expireAt' => '2023-11-07T05:31:56Z',
    'hashData' => [
        'keyIdHash' => '<string>',
        'keyIdSuffix' => '<string>',
        'keySecretHash' => '<string>'
    ],
    'ipAccessList' => [
        [
                'description' => '<string>',
                'source' => '<string>'
        ]
    ],
    'name' => '<string>',
    'roles' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"expireAt\": \"2023-11-07T05:31:56Z\",\n  \"hashData\": {\n    \"keyIdHash\": \"<string>\",\n    \"keyIdSuffix\": \"<string>\",\n    \"keySecretHash\": \"<string>\"\n  },\n  \"ipAccessList\": [\n    {\n      \"description\": \"<string>\",\n      \"source\": \"<string>\"\n    }\n  ],\n  \"name\": \"<string>\",\n  \"roles\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expireAt\": \"2023-11-07T05:31:56Z\",\n  \"hashData\": {\n    \"keyIdHash\": \"<string>\",\n    \"keyIdSuffix\": \"<string>\",\n    \"keySecretHash\": \"<string>\"\n  },\n  \"ipAccessList\": [\n    {\n      \"description\": \"<string>\",\n      \"source\": \"<string>\"\n    }\n  ],\n  \"name\": \"<string>\",\n  \"roles\": []\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expireAt\": \"2023-11-07T05:31:56Z\",\n  \"hashData\": {\n    \"keyIdHash\": \"<string>\",\n    \"keyIdSuffix\": \"<string>\",\n    \"keySecretHash\": \"<string>\"\n  },\n  \"ipAccessList\": [\n    {\n      \"description\": \"<string>\",\n      \"source\": \"<string>\"\n    }\n  ],\n  \"name\": \"<string>\",\n  \"roles\": []\n}"

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

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
}

{
  "error": "<string>",
  "status": 400
}

授权

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

Show child attributes

ipAccessList · object[]

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

Show child attributes

name · string

key 的名称。

roles · enum<string>[]

分配给该 key 的 role 列表。至少包含 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