Skip to main content
POST
Créer un nouveau service

Autorisations

Authorization
string
header
requis

Utilisez l’ID de la clé et le secret de la clé obtenus dans la ClickHouse Cloud console : https://clickhouse.com/docs/cloud/manage/openapi

Paramètres de chemin

organizationId
string<uuid>
requis

ID de l’organisation propriétaire du service.

Corps

application/json
backupId
string<uuid>

ID de sauvegarde facultatif utilisé comme état initial du nouveau service. Lorsqu’il est utilisé, la région et le tier de la nouvelle instance doivent être identiques à ceux de l’instance d’origine.

byocId
string

Il s’agit de l’ID renvoyé après la configuration d’une région pour Bring Your Own Cloud (BYOC). Lorsque le paramètre byocId est spécifié, les paramètres minReplicaMemoryGb et maxReplicaGb sont également requis, avec des valeurs parmi les tailles suivantes : 48, 116, 172, 232.

complianceType
enum<string>

Type de conformité réglementaire du service.

Options disponibles:
hipaa,
pci
dataWarehouseId
string

Data warehouse contenant ce service

encryptionAssumedRoleIdentifier
string

Rôle facultatif à utiliser pour le chiffrement du disque

encryptionKey
string

Clé facultative de chiffrement du disque fournie par le client

endpoints
object[]

Liste des endpoints du service à activer ou désactiver

hasTransparentDataEncryption
boolean

True si Transparent Data Encryption (TDE) doit être activé pour le service. TDE n’est disponible que pour les tiers d’organisation ENTERPRISE et ne peut être activé qu’à la création du service.

idleScaling
boolean

Lorsque ce paramètre est défini sur true, le service peut être ramené à zéro lorsqu’il est inactif. True par défaut.

idleTimeoutMinutes
number

Définissez le délai minimal avant mise en veille (en minutes). Doit être >= 5 minutes.

ipAccessList
object[]

Liste des adresses IP autorisées à accéder au service

isReadonly
boolean

True si ce service est en lecture seule. Il ne peut être en lecture seule que si un dataWarehouseId est fourni.

maxReplicaMemoryGb
number

Mémoire totale maximale de chaque réplique pendant l’auto-scaling, en Gb. Doit être un multiple de 4 et inférieure ou égale à 120* pour les services non payants ou à 356* pour les services payants.* - taille maximale de réplique soumise à la disponibilité matérielle du fournisseur cloud dans la région sélectionnée.

Plage requise: 8 <= x <= 356Doit être un multiple de 4
Exemple:

120

maxTotalMemoryGb
number
obsolète

OBSOLÈTE - imprécis pour les services avec un nombre de répliques différent de la valeur par défaut. Mémoire maximale de trois workers pendant l’auto-scaling, en Gb. Disponible uniquement pour les services 'production'. Doit être un multiple de 12 et inférieur ou égal à 360 pour les services non payants ou à 1068 pour les services payants.

Plage requise: 24 <= x <= 1068Doit être un multiple de 12
Exemple:

360

minReplicaMemoryGb
number

Mémoire totale minimale de chaque réplique pendant l’auto-scaling, en Gb. Doit être un multiple de 4 et supérieur ou égal à 8.

Plage requise: 8 <= x <= 356Doit être un multiple de 4
Exemple:

16

minTotalMemoryGb
number
obsolète

OBSOLÈTE - imprécis pour les services avec un nombre de répliques différent de la valeur par défaut. Mémoire minimale de trois workers pendant l’auto-scaling, en Gb. Disponible uniquement pour les services 'production'. Doit être un multiple de 12 et supérieur ou égal à 24.

Plage requise: 24 <= x <= 1068Doit être un multiple de 12
Exemple:

48

name
string

Nom du service. Chaîne alphanumérique pouvant contenir des espaces, jusqu’à 50 caractères.

numReplicas
number

Nombre de répliques du service. Le nombre de répliques doit être compris entre 2 et 20 pour le premier service d’un warehouse. Les services créés dans un warehouse existant peuvent avoir seulement 1 réplique. D’autres restrictions peuvent s’appliquer selon le tier de votre organisation. La valeur par défaut est de 1 pour le tier BASIC et de 3 pour les tiers SCALE et ENTERPRISE.

Plage requise: 1 <= x <= 20
Exemple:

3

privateEndpointIds
string[]
obsolète

Pour associer le service à des private endpoints, créez d’abord le service, puis utilisez le endpoint Update Service Basic Details pour modifier les private endpoints.

privatePreviewTermsChecked
boolean

Acceptez les terms and conditions de la private preview. Cela n’est nécessaire que lors de la création du premier service de l’organisation dans le cadre d’une private preview

profile
enum<string>

Profil d'instance personnalisé. Disponible uniquement pour les niveaux d'organisation ENTERPRISE.

Options 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>

Fournisseur cloud

Options disponibles:
aws,
gcp,
azure
region
enum<string>

Région du service.

Options 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>

Sélectionnez fast si vous souhaitez obtenir les nouvelles releases de ClickHouse dès qu’elles sont disponibles. Vous bénéficierez plus rapidement des nouvelles fonctionnalités, mais avec un risque plus élevé de bogues. Sélectionnez slow si vous souhaitez différer les releases afin de disposer de plus de temps pour les tester. Cette fonctionnalité n’est disponible que pour les services de production. La valeur par défaut est le regular release channel.

Options disponibles:
slow,
default,
fast
tier
enum<string>
obsolète

OBSOLÈTE pour les tiers d’organisation BASIC, SCALE et ENTERPRISE. Tier du service : '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'. Les services de production sont extensibles, tandis que ceux du tier Development ont une taille fixe. Les services Azure ne prennent pas en charge le tier Development

Options 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

Réponse

Réponse réussie

requestId
string<uuid>

ID unique attribué à chaque requête. UUIDv4

result
object
status
number

Code de statut HTTP.

Exemple:

200

Dernière modification le 1 juillet 2026