新しいサービスを作成

組織内に新しいserviceを作成し、現在のserviceのstateと、そのserviceにアクセスするためのパスワードを返します。serviceは非同期で開始されます。

POST /v1/organizations/{organizationId}/services

新しいサービスを作成

cURL

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "backupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "byocId": "<string>",
  "dataWarehouseId": "<string>",
  "encryptionAssumedRoleIdentifier": "<string>",
  "encryptionKey": "<string>",
  "endpoints": [
    {
      "enabled": true,
      "protocol": "mysql"
    }
  ],
  "hasTransparentDataEncryption": true,
  "idleScaling": true,
  "idleTimeoutMinutes": 123,
  "ipAccessList": [
    {
      "description": "<string>",
      "source": "<string>"
    }
  ],
  "isReadonly": true,
  "maxReplicaMemoryGb": 120,
  "maxTotalMemoryGb": 360,
  "minReplicaMemoryGb": 16,
  "minTotalMemoryGb": 48,
  "name": "<string>",
  "numReplicas": 3,
  "privateEndpointIds": [
    "<string>"
  ],
  "privatePreviewTermsChecked": true
}
'

200

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "password": "<string>",
    "service": {
      "availablePrivateEndpointIds": [
        "<string>"
      ],
      "byocId": "<string>",
      "clickhouseVersion": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "dataWarehouseId": "<string>",
      "encryptionAssumedRoleIdentifier": "<string>",
      "encryptionKey": "<string>",
      "encryptionRoleId": "<string>",
      "endpoints": [
        {
          "host": "<string>",
          "port": 123,
          "protocol": "mysql",
          "username": "<string>"
        }
      ],
      "hasTransparentDataEncryption": true,
      "iamRole": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "idleScaling": true,
      "idleTimeoutMinutes": 123,
      "ipAccessList": [
        {
          "description": "<string>",
          "source": "<string>"
        }
      ],
      "isPrimary": true,
      "isReadonly": true,
      "maxReplicaMemoryGb": 120,
      "maxTotalMemoryGb": 360,
      "minReplicaMemoryGb": 16,
      "minTotalMemoryGb": 48,
      "name": "<string>",
      "numReplicas": 3,
      "privateEndpointIds": [
        "<string>"
      ],
      "transparentDataEncryptionKeyId": "<string>"
    }
  },
  "status": 200
}

承認

Authorization · string · header · 必須

ClickHouse Cloud コンソールで取得した key ID と key secret を使用してください: https://clickhouse.com/docs/cloud/manage/openapi

パスパラメータ

organizationId · string<uuid> · 必須

serviceを所有する組織のID。

ボディ

application/json

backupId · string<uuid>

新しいサービスの初期状態として使用する任意のbackup ID。これを使用する場合、新しいインスタンスのリージョンとtierは元のインスタンスの値と同じである必要があります。

byocId · string

これは、Bring Your Own Cloud (BYOC) 向けにリージョンを設定した後に返されるIDです。byocId parameter を指定する場合は、minReplicaMemoryGb と maxReplicaGb parameter も必須で、値は次のサイズのいずれかである必要があります: 48, 116, 172, 232。

complianceType · enum<string>

サービスの規制コンプライアンスの種類。

利用可能なオプション: hipaa, pci

dataWarehouseId · string

このサービスを含むdata warehouse

encryptionAssumedRoleIdentifier · string

ディスク暗号化に使用する任意のロール

encryptionKey · string

任意の顧客提供ディスク暗号化キー

endpoints · object[]

有効化または無効化するサービスのendpointの一覧

Show child attributes

hasTransparentDataEncryption · boolean

サービスでTransparent Data Encryption (TDE) を有効にする場合はtrueです。TDEはENTERPRISE organization tierでのみ利用可能で、サービス作成時にのみ有効にできます。

idleScaling · boolean

trueに設定すると、サービスはアイドル時に0までスケールダウンできます。デフォルトはtrueです。

idleTimeoutMinutes · number

最小アイドルタイムアウト（分）を設定します。5分以上である必要があります。

ipAccessList · object[]

サービスへのアクセスが許可されているIPアドレスの一覧

Show child attributes

isReadonly · boolean

このサービスがread-onlyの場合はtrueです。read-onlyにできるのは、dataWarehouseIdが指定されている場合のみです。

maxReplicaMemoryGb · number

自動スケーリング時における各レプリカの合計最大メモリ容量（Gb）。4の倍数で、無償サービスでは120以下、有償サービスでは356以下である必要があります。* - レプリカの最大サイズは、選択したリージョンにおけるクラウドプロバイダーのハードウェア提供状況に左右されます。

必須範囲: 8 <= x <= 356次の倍数である必要があります 4

例:

120

maxTotalMemoryGb · number · 非推奨

非推奨 - レプリカ数がデフォルト以外のサービスでは正確ではありません。自動スケーリング時における3つのworkerの最大メモリ容量（Gb）。'production'サービスでのみ利用可能です。12の倍数で、無償サービスでは360以下、有償サービスでは1068以下である必要があります。

必須範囲: 24 <= x <= 1068次の倍数である必要があります 12

例:

360

minReplicaMemoryGb · number

自動スケーリング時における各レプリカの合計最小メモリ容量（Gb）。4の倍数かつ8以上である必要があります。

必須範囲: 8 <= x <= 356次の倍数である必要があります 4

例:

16

minTotalMemoryGb · number · 非推奨

非推奨 - レプリカ数がデフォルト以外のサービスでは正確ではありません。自動スケーリング時における3つのworkerの最小メモリ容量（Gb）。'production'サービスでのみ利用可能です。12の倍数かつ24以上である必要があります。

必須範囲: 24 <= x <= 1068次の倍数である必要があります 12

例:

48

name · string

サービス名。空白を含めて最大50文字の英数字文字列。

numReplicas · number

サービスのレプリカ数。warehouse内の最初のサービスでは、レプリカ数は2～20である必要があります。既存のwarehouse内に作成されるサービスでは、レプリカ数を1まで設定できます。organizationのtierによっては、さらに制限が適用される場合があります。デフォルトはBASIC tierでは1、SCALEおよびENTERPRISE tierでは3です。

必須範囲: 1 <= x <= 20

例:

3

privateEndpointIds · string[] · 非推奨

サービスをプライベート エンドポイントに関連付けるには、まずサービスを作成し、その後 Update Service Basic Details endpoint を使用してプライベート エンドポイントを変更します。

privatePreviewTermsChecked · boolean

プライベートプレビューの利用規約に同意します。プライベートプレビューの場合、organizationで最初のサービスを作成するときにのみ必要です

profile · enum<string>

カスタムインスタンスプロファイル。ENTERPRISE 組織ティアでのみ利用できます。

利用可能なオプション: v1-default, v1-highmem-xs, v1-highmem-s, v1-highmem-m, v1-highmem-l, v1-highmem-xl, v1-highcpu-s, v1-highcpu-m, v1-highcpu-l, v1-highcpu-xl

provider · enum<string>

クラウドプロバイダー

利用可能なオプション: aws, gcp, azure

region · enum<string>

サービスのリージョン。

利用可能なオプション: ap-northeast-1, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, eu-west-2, me-central-1, us-east-1, us-east-2, us-west-2, us-east1, us-central1, europe-west4, asia-southeast1, eastus, eastus2, westus3, germanywestcentral

releaseChannel · enum<string>

新しいClickHouse releasesを利用可能になり次第すぐに取得したい場合はfastを選択します。新機能をより早く利用できますが、不具合のリスクは高くなります。リリースを遅らせてテストにより多くの時間を確保したい場合はslowを選択します。この機能はproductionサービスでのみ利用可能です。デフォルトはregular release channelです。

利用可能なオプション: slow, default, fast

tier · enum<string> · 非推奨

BASIC、SCALE、ENTERPRISEのorganization tierでは非推奨。サービスのtier: 'development'、'production'、'dedicated_high_mem'、'dedicated_high_cpu'、'dedicated_standard'、'dedicated_standard_n2d_standard_4'、'dedicated_standard_n2d_standard_8'、'dedicated_standard_n2d_standard_32'、'dedicated_standard_n2d_standard_128'、'dedicated_standard_n2d_standard_32_16SSD'、'dedicated_standard_n2d_standard_64_24SSD'。Productionサービスはスケーリングし、Developmentは固定サイズです。AzureのサービスではDevelopment tierはサポートされていません

利用可能なオプション: development, production, dedicated_high_mem, dedicated_high_cpu, dedicated_standard, dedicated_standard_n2d_standard_4, dedicated_standard_n2d_standard_8, dedicated_standard_n2d_standard_32, dedicated_standard_n2d_standard_128, dedicated_standard_n2d_standard_32_16SSD, dedicated_standard_n2d_standard_64_24SSD

レスポンス

200

application/json

成功時のレスポンス

requestId · string<uuid>

各リクエストに割り当てられる一意のID。UUIDv4

result · object

Show child attributes

status · number

HTTPステータスコード。

例:

200