API Key 관리 - ClickHouse Documentation

ClickHouse Cloud는 OpenAPI를 사용하는 API를 제공하며, 이를 통해 계정과 서비스의 여러 측면을 프로그래밍 방식으로 관리할 수 있습니다.

이 문서는 ClickHouse Cloud API를 다룹니다. 데이터베이스 API 엔드포인트에 대해서는 Cloud Endpoints API를 참조하십시오.

API Keys 페이지 열기

왼쪽 메뉴의 API Keys 탭에서 API Key를 생성하고 관리할 수 있습니다.

API Key 생성 시작

API Keys 페이지에는 처음에 아래와 같이 첫 번째 API Key를 생성하라는 안내가 표시됩니다. 첫 번째 키를 생성한 후에는 오른쪽 상단에 표시되는 New API Key 버튼을 사용해 새 키를 생성할 수 있습니다.

API Key 구성

키 이름, 키 권한, 만료 시간을 지정합니다.

권한은 ClickHouse Cloud의 사전 정의된 역할과 일치합니다. 개발자 역할에는 할당된 서비스에 대한 읽기 전용 권한이 있으며, 관리자 역할에는 전체 읽기 및 쓰기 권한이 있습니다.

Query API EndpointsAPI Key를 Query API Endpoints와 함께 사용하려면 Organization Role을 최소 Member로 설정하고 Service Role 액세스를 Query Endpoints에 부여하십시오.

허용된 IP 주소 추가

어떤 클라이언트가 API Key를 사용할 수 있는지 제한하려면 Allow access to this API Key 섹션에서 Specific locations를 선택하십시오. 203.0.113.1 또는 203.0.113.0/24와 같은 IP 주소 또는 CIDR 범위를 입력하고 필요에 따라 항목을 추가하십시오.Query API endpoints는 API Key 수준의 IP 허용 목록을 따릅니다. 요청은 ClickHouse 인프라 내부에서 프록시되므로 서비스 수준의 IP 허용 목록은 적용되지 않습니다. 자세한 내용은 IP Access Control을 참조하십시오.키 구성을 마쳤으면 Generate API Key를 클릭하십시오.

API Key 자격 증명 저장

다음 화면에 Key ID와 Key secret이 표시됩니다. 이 값들을 복사해 볼트와 같은 안전한 곳에 저장하십시오. 이 화면을 벗어나면 해당 값은 다시 표시되지 않습니다.

API 요청 인증

ClickHouse Cloud API는 API Key의 유효성을 확인하기 위해 HTTP 기본 인증을 사용합니다. 다음은 curl을 사용해 API Key로 ClickHouse Cloud API에 요청을 보내는 예시입니다.

$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

$ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations

기존 API Key 관리

API Keys 페이지로 돌아가면 키 이름, Key ID의 마지막 4자, 권한, 상태, 만료일, 생성자가 표시됩니다. 이 화면에서 키 이름, 권한, 만료일을 수정할 수 있으며, 키를 비활성화하거나 삭제할 수도 있습니다.

API Key 삭제는 되돌릴 수 없는 영구적인 작업입니다. 해당 키를 사용하는 모든 서비스는 즉시 ClickHouse Cloud에 대한 액세스 권한을 잃게 됩니다.

엔드포인트

엔드포인트에 대한 자세한 내용은 API 참조를 참조하십시오. API Key와 API Secret은 기준 URL https://api.clickhouse.cloud/v1과 함께 사용하십시오.

​엔드포인트

엔드포인트