Crear un nuevo servicio

Crea un nuevo servicio en la organización y devuelve el estado actual del servicio y una contraseña para acceder a él. El servicio se inicia de forma asíncrona.

POST /v1/organizations/{organizationId}/services

Crear un nuevo servicio

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
}

Autorizaciones

Authorization · string · header · requerido

Usa el ID de la clave y el secreto de la clave obtenidos en la consola de ClickHouse Cloud: https://clickhouse.com/docs/cloud/manage/openapi

Parámetros de ruta

organizationId · string<uuid> · requerido

ID de la organización que será propietaria del servicio.

Cuerpo

application/json

backupId · string<uuid>

ID de Backup opcional que se usa como estado inicial del nuevo servicio. Cuando se usa, la región y el nivel de la nueva instancia deben ser los mismos que los de la instancia original.

byocId · string

Este es el ID que se devuelve después de configurar una región para Bring Your Own Cloud (BYOC). Cuando se especifica el parámetro byocId, también son obligatorios los parámetros minReplicaMemoryGb y maxReplicaGb, con valores entre los siguientes tamaños: 48, 116, 172, 232.

complianceType · enum<string>

Tipo de cumplimiento normativo del servicio.

Opciones disponibles: hipaa, pci

dataWarehouseId · string

Warehouse de datos que contiene este servicio

encryptionAssumedRoleIdentifier · string

Role opcional que se usará para el cifrado de disco

encryptionKey · string

Clave de cifrado de disco opcional proporcionada por el cliente

endpoints · object[]

Lista de endpoints del servicio para habilitar o deshabilitar

Show child attributes

hasTransparentDataEncryption · boolean

True si el servicio debe tener habilitado el Cifrado transparente de datos (TDE). TDE solo está disponible para los niveles de la organización ENTERPRISE y solo puede habilitarse al crear el servicio.

idleScaling · boolean

Cuando se establece en true, el servicio puede escalar hasta cero cuando está idle. True de forma predeterminada.

idleTimeoutMinutes · number

Establezca el timeout mínimo de idling (en minutos). Debe ser >= 5 minutos.

ipAccessList · object[]

Lista de direcciones IP autorizadas para acceder al servicio

Show child attributes

isReadonly · boolean

True si este servicio es read-only. Solo puede ser read-only si se proporciona un dataWarehouseId.

maxReplicaMemoryGb · number

Memoria total máxima de cada réplica durante el autoescalado, en Gb. Debe ser un múltiplo de 4 y menor o igual que 120* para servicios no pagos o 356* para servicios pagos.* - el tamaño máximo de la réplica está sujeto a la disponibilidad de hardware del proveedor de Cloud en la región seleccionada.

Rango requerido: 8 <= x <= 356Debe ser un múltiplo de 4

Ejemplo:

120

maxTotalMemoryGb · number · obsoleto

DEPRECATED: no es preciso para servicios con una cantidad no predeterminada de réplicas. Memoria máxima de tres workers durante el autoescalado, en Gb. Disponible solo para servicios 'production'. Debe ser un múltiplo de 12 y menor o igual que 360 para servicios no pagos o 1068 para servicios pagos.

Rango requerido: 24 <= x <= 1068Debe ser un múltiplo de 12

Ejemplo:

360

minReplicaMemoryGb · number

Memoria total mínima de cada réplica durante el autoescalado, en Gb. Debe ser un múltiplo de 4 y mayor o igual que 8.

Rango requerido: 8 <= x <= 356Debe ser un múltiplo de 4

Ejemplo:

16

minTotalMemoryGb · number · obsoleto

DEPRECATED: no es preciso para servicios con una cantidad no predeterminada de réplicas. Memoria mínima de tres workers durante el autoescalado, en Gb. Disponible solo para servicios 'production'. Debe ser un múltiplo de 12 y mayor o igual que 24.

Rango requerido: 24 <= x <= 1068Debe ser un múltiplo de 12

Ejemplo:

48

name · string

Nombre del servicio. Cadena alfanumérica con espacios de hasta 50 caracteres.

numReplicas · number

Número de réplicas del servicio. La cantidad de réplicas debe estar entre 2 y 20 para el primer servicio de un warehouse. Los servicios que se crean en un warehouse existente pueden tener solo 1 réplica. Pueden aplicarse restricciones adicionales según el nivel de su organización. El valor predeterminado es 1 para el nivel BASIC y 3 para los niveles SCALE y ENTERPRISE.

Rango requerido: 1 <= x <= 20

Ejemplo:

3

privateEndpointIds · string[] · obsoleto

Para asociar el servicio con private endpoints, primero cree el servicio y luego use el endpoint Update Service Basic Details para modificar los private endpoints.

privatePreviewTermsChecked · boolean

Acepte los terms y conditions de private preview. Solo es necesario al crear el primer servicio de la organización en caso de private preview

profile · enum<string>

Perfil de instancia personalizado. Solo disponible para los niveles de la organización ENTERPRISE.

Opciones disponibles: 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>

Proveedor de Cloud

Opciones disponibles: aws, gcp, azure

region · enum<string>

Región del servicio.

Opciones disponibles: 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>

Seleccione fast si desea obtener las nuevas versiones de ClickHouse en cuanto estén disponibles. Obtendrá Nuevas características más rápido, pero con un mayor riesgo de errores. Seleccione slow si desea aplazar las versiones para tener más tiempo para probarlas. Esta característica solo está disponible para servicios de production. El valor predeterminado es el regular release channel.

Opciones disponibles: slow, default, fast

tier · enum<string> · obsoleto

DEPRECATED para los niveles de la organización BASIC, SCALE y ENTERPRISE. Nivel del servicio: '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'. Los servicios Production escalan; los Development tienen un tamaño fijo. Los servicios de Azure no admiten el nivel Development

Opciones disponibles: 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

Respuesta

200

application/json

Respuesta satisfactoria

requestId · string<uuid>

ID único asignado a cada solicitud. UUIDv4

result · object

Show child attributes

status · number

Código de estado HTTP.

Ejemplo:

200