키 생성

새 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> · 필수

키를 소유할 조직의 ID입니다.

본문

application/json

expireAt · string<date-time> | null

key가 만료되는 timestamp입니다. 값이 없거나 null이거나 비어 있으면 key는 만료되지 않습니다. ISO-8601 형식입니다.

hashData · object

Show child attributes

ipAccessList · object[]

이 key를 사용해 API에 접근할 수 있도록 허용된 IP 주소 목록

Show child attributes

name · string

key 이름입니다.

roles · enum<string>[]

key에 할당된 역할 목록입니다. 최소 1개의 요소를 포함합니다.

사용 가능한 옵션: admin, developer, query_endpoints

state · enum<string>

key의 초기 state입니다: 'enabled', 'disabled'. 제공하지 않으면 새 key는 'enabled'로 설정됩니다.

사용 가능한 옵션: enabled, disabled

응답

200

application/json

성공 응답

requestId · string<uuid>

각 요청에 할당되는 고유 ID입니다. UUIDv4

result · object

Show child attributes

status · number

HTTP 상태 코드입니다.

예시:

200