> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-detect-table-modification.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickHouse Cloud API

> ClickHouse Cloud API에 대해 알아보십시오

<div id="overview">
  ## 개요
</div>

ClickHouse Cloud API는 개발자가 ClickHouse Cloud에서 조직과 서비스를 손쉽게 관리할 수 있도록 설계된 REST API입니다. Cloud API를 사용하면 서비스를 생성 및 관리하고, API Key를 발급하고, 조직의 구성원을 추가하거나 제거하는 등 다양한 작업을 수행할 수 있습니다.

[첫 번째 API Key를 생성하고 ClickHouse Cloud API 사용을 시작하는 방법을 알아보세요.](/ko/products/cloud/features/admin-features/api/openapi)

<div id="swagger-openapi-endpoint-and-ui">
  ## Swagger (OpenAPI) 엔드포인트 및 UI
</div>

ClickHouse Cloud API는 클라이언트 측에서 예측 가능하게 활용할 수 있도록 오픈소스 [OpenAPI specification](https://www.openapis.org/)을 기반으로 구축되었습니다.
ClickHouse Cloud API 문서를 프로그래밍 방식으로 활용해야 하는 경우,
[https://api.clickhouse.cloud/v1에서](https://api.clickhouse.cloud/v1에서) JSON 기반 Swagger 엔드포인트를 제공합니다.
또한 [Swagger UI](/ko/products/cloud/api-reference/organization/get-list-of-available-organizations)에서도 API 문서를 확인할 수 있습니다.

<Note>
  조직이 [새로운 요금제](https://clickhouse.com/pricing?plan=scale\&provider=aws\&region=us-east-1\&hours=8\&storageCompressed=false) 중 하나로 마이그레이션되었고 OpenAPI를 사용하는 경우, 서비스 생성 `POST` 요청에서 `tier` 필드를 제거해야 합니다.

  더 이상 서비스 티어가 없으므로 서비스 객체에서 `tier` 필드가 제거되었습니다.
  이 변경은 `POST`, `GET`, `PATCH` 서비스 요청에서 반환되는 객체에 영향을 줍니다. 따라서 이러한 API를 활용하는 코드는 이 변경 사항을 처리할 수 있도록 조정해야 할 수 있습니다.
</Note>

<div id="rate-limits">
  ## 요청 제한
</div>

조직당 API Key는 최대 100개까지 생성할 수 있습니다. 각 API Key는
10초 동안 최대 10개의 요청으로 제한됩니다. 조직의 API Key 수 또는 10초당 요청 수를
늘리려면 [support@clickhouse.com](mailto:support@clickhouse.com)으로 문의하십시오.

<div id="terraform-provider">
  ## Terraform 프로바이더
</div>

공식 ClickHouse Terraform 프로바이더를 사용하면 [Infrastructure as Code](https://www.redhat.com/en/topics/automation/what-is-infrastructure-as-code-iac)를 통해 예측 가능하고 버전 관리되는 구성을 생성하여 배포 시 오류 발생 가능성을 크게 줄일 수 있습니다.

[Terraform registry](https://registry.terraform.io/providers/ClickHouse/clickhouse/latest/docs)에서 Terraform 프로바이더 문서를 확인할 수 있습니다.

ClickHouse Terraform Provider에 기여하려면 [GitHub repo](https://github.com/ClickHouse/terraform-provider-clickhouse)에서
소스 코드를 확인할 수 있습니다.

<Note>
  조직이 [새 요금제](https://clickhouse.com/pricing?plan=scale\&provider=aws\&region=us-east-1\&hours=8\&storageCompressed=false) 중 하나로 이전된 경우, [ClickHouse Terraform 프로바이더](https://registry.terraform.io/providers/ClickHouse/clickhouse/latest/docs) 버전 2.0.0 이상을 사용해야 합니다. 이 업그레이드는 서비스의 `tier` 속성 변경을 처리하기 위해 필요합니다. 요금제 이전 이후에는 `tier` 필드가 더 이상 허용되지 않으므로 관련 참조를 제거해야 합니다.

  이제 서비스 리소스의 속성으로 `num_replicas` 필드도 지정할 수 있습니다.
</Note>

<div id="terraform-provider-releases">
  ## Terraform 프로바이더 릴리스
</div>

ClickHouse는 2개의 공식 Terraform 프로바이더를 제공합니다. 하나는 클라우드 인프라용 ClickHouse Cloud 프로바이더이고, 다른 하나는 데이터베이스 수준의 객체용 DBops 프로바이더입니다. 두 프로바이더 모두 동일한 릴리스 모델을 따릅니다.

<div id="ga-vs-beta-resources">
  ### 일반 제공 리소스와 베타 리소스
</div>

각 릴리스는 모든 리소스를 포함하는 단일 빌드입니다. 아직 일반 제공 단계에 이르지 않은 기능의 리소스도 일반 제공 리소스와 함께 **베타**로 표시되어 제공됩니다. 별도의 빌드는 없으며, 이를 사용하기 위해 특정 버전을 고정할 필요도 없습니다.

베타 리소스는 다음 두 위치에서 확인할 수 있습니다.

* **계획 및 적용 시점**에 `Beta Resource` 경고가 표시됩니다. Terraform은 경고 때문에 실패하지 않으므로 실행은 정상적으로 계속됩니다.
* **문서**에서 "이 리소스는 베타 버전입니다"라는 안내문이 표시됩니다.

베타는 향후 프로바이더 버전에서 스키마와 동작이 변경될 수 있음을 의미합니다. 이 표시가 없는 항목은 모두 일반 제공 상태이며 일반적인 호환성 보장이 적용됩니다.

<Note>
  v3.25.2 이전에는 프로바이더가 이러한 리소스를 *베타* 대신 *알파*로 표시했으며, 계획 시점 경고는 `Alpha Resource`였습니다. 변경된 것은 표현뿐이며 스키마, 동작 또는 상태 마이그레이션은 관련되지 않습니다. 다만 계획 출력에서 `Alpha Resource`를 grep하는 도구는 아무런 알림 없이 더 이상 일치하지 않게 됩니다. 이전 릴리스에서는 별도의 알파 빌드도 제공했습니다.
</Note>

<div id="versioning">
  ### 버전 관리
</div>

두 프로바이더 모두 시맨틱 버전 관리(MAJOR.MINOR.PATCH)를 사용합니다. 메이저 버전은 호환성이 깨지는 변경이 있을 때 증가하고, 마이너 버전은 새로운 기능이나 리소스가 추가될 때 증가하며, 패치 버전은 버그를 수정할 때 증가합니다. 릴리스는 고정된 일정이 아니라 필요에 따라 생성됩니다.

`-alphaN` 접미사가 있는 버전(예: `3.15.0-alpha3`)은 단일 빌드 모델 이전의 버전입니다. 계속 사용할 수 있지만 더 이상 생성되지는 않습니다.

<div id="promotion">
  ### 베타에서 일반 제공으로 승격
</div>

기능이 일반 제공 상태가 되면 다음 프로바이더 릴리스에서 해당 리소스의 베타 표시가 제거됩니다. 계획 단계 경고가 더 이상 표시되지 않고 문서의 안내 문구도 삭제됩니다. 그 외에는 변경되는 사항이 없습니다. 구성 편집, 상태 마이그레이션 또는 빌드 간 전환도 필요하지 않습니다.

<div id="terraform-and-openapi-new-pricing---replica-settings-explained">
  ## Terraform 및 OpenAPI 새 요금제: 레플리카 설정 설명
</div>

각 서비스가 생성될 때 기본 레플리카 수는 Scale 및 Enterprise 티어에서는 3개이고, Basic 티어에서는 1개입니다.
Scale 및 Enterprise 티어에서는 서비스 생성 요청에 `numReplicas` 필드를 전달하여 이 값을 조정할 수 있습니다.
`numReplicas` 필드 값은 warehouse의 첫 번째 서비스에서는 2 이상 20 이하여야 합니다. 기존 warehouse에서 생성되는 서비스는 레플리카 수를 최소 1개까지 설정할 수 있습니다.

<div id="support">
  ## 지원
</div>

빠른 지원이 필요하면 먼저 [Slack 채널](https://clickhouse.com/slack)을 방문하는 것이 좋습니다. 추가 지원이 필요하거나 API 및 해당 기능에 대한 자세한 정보가 필요하면 [https://console.clickhouse.cloud/support에서](https://console.clickhouse.cloud/support에서) ClickHouse 지원팀에 문의하십시오.