新しいサービスを作成

組織内に新しいserviceを作成し、現在のserviceの状態と、そのserviceにアクセスするためのpasswordを返します。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
}
'

import requests

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

payload = {
    "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
}
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({
    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
  })
};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/services', 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}/services",
  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([
    '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
  ]),
  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}/services"

	payload := strings.NewReader("{\n  \"backupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"byocId\": \"<string>\",\n  \"dataWarehouseId\": \"<string>\",\n  \"encryptionAssumedRoleIdentifier\": \"<string>\",\n  \"encryptionKey\": \"<string>\",\n  \"endpoints\": [\n    {\n      \"enabled\": true,\n      \"protocol\": \"mysql\"\n    }\n  ],\n  \"hasTransparentDataEncryption\": true,\n  \"idleScaling\": true,\n  \"idleTimeoutMinutes\": 123,\n  \"ipAccessList\": [\n    {\n      \"description\": \"<string>\",\n      \"source\": \"<string>\"\n    }\n  ],\n  \"isReadonly\": true,\n  \"maxReplicaMemoryGb\": 120,\n  \"maxTotalMemoryGb\": 360,\n  \"minReplicaMemoryGb\": 16,\n  \"minTotalMemoryGb\": 48,\n  \"name\": \"<string>\",\n  \"numReplicas\": 3,\n  \"privateEndpointIds\": [\n    \"<string>\"\n  ],\n  \"privatePreviewTermsChecked\": true\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}/services")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"backupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"byocId\": \"<string>\",\n  \"dataWarehouseId\": \"<string>\",\n  \"encryptionAssumedRoleIdentifier\": \"<string>\",\n  \"encryptionKey\": \"<string>\",\n  \"endpoints\": [\n    {\n      \"enabled\": true,\n      \"protocol\": \"mysql\"\n    }\n  ],\n  \"hasTransparentDataEncryption\": true,\n  \"idleScaling\": true,\n  \"idleTimeoutMinutes\": 123,\n  \"ipAccessList\": [\n    {\n      \"description\": \"<string>\",\n      \"source\": \"<string>\"\n    }\n  ],\n  \"isReadonly\": true,\n  \"maxReplicaMemoryGb\": 120,\n  \"maxTotalMemoryGb\": 360,\n  \"minReplicaMemoryGb\": 16,\n  \"minTotalMemoryGb\": 48,\n  \"name\": \"<string>\",\n  \"numReplicas\": 3,\n  \"privateEndpointIds\": [\n    \"<string>\"\n  ],\n  \"privatePreviewTermsChecked\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"backupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"byocId\": \"<string>\",\n  \"dataWarehouseId\": \"<string>\",\n  \"encryptionAssumedRoleIdentifier\": \"<string>\",\n  \"encryptionKey\": \"<string>\",\n  \"endpoints\": [\n    {\n      \"enabled\": true,\n      \"protocol\": \"mysql\"\n    }\n  ],\n  \"hasTransparentDataEncryption\": true,\n  \"idleScaling\": true,\n  \"idleTimeoutMinutes\": 123,\n  \"ipAccessList\": [\n    {\n      \"description\": \"<string>\",\n      \"source\": \"<string>\"\n    }\n  ],\n  \"isReadonly\": true,\n  \"maxReplicaMemoryGb\": 120,\n  \"maxTotalMemoryGb\": 360,\n  \"minReplicaMemoryGb\": 16,\n  \"minTotalMemoryGb\": 48,\n  \"name\": \"<string>\",\n  \"numReplicas\": 3,\n  \"privateEndpointIds\": [\n    \"<string>\"\n  ],\n  \"privatePreviewTermsChecked\": true\n}"

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

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
}

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

承認

Authorization · string · header · 必須

ClickHouse Cloud console で取得した 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

このサービスを含むデータwarehouse

encryptionAssumedRoleIdentifier · string

ディスク暗号化に使用するオプションのロール

encryptionKey · string

オプションのカスタマー提供ディスク暗号化キー

endpoints · object[]

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

Show child attributes

hasTransparentDataEncryption · boolean

サービスで透過的データ暗号化 (TDE) を有効にする場合は true。TDE は ENTERPRISE の組織tierでのみ利用可能で、サービス作成時にのみ有効化できます。

idleScaling · boolean

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

idleTimeoutMinutes · number

最小アイドルtimeout（分）を設定します。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まで下げられます。さらに、組織のtierに応じて追加の制限が適用される場合があります。デフォルトはBASIC tierで1、SCALEおよびENTERPRISE tierで3です。

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

例:

3

privateEndpointIds · string[] · 非推奨

サービスをprivate endpointsに関連付けるには、まずサービスを作成してから、Update Service Basic Details endpoint を使用してprivate endpointsを変更してください。

privatePreviewTermsChecked · boolean

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

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 の組織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