Service references
All operations require authentication.
List Analytics availabilitiesBeta
Returns the combinations of Analytics engine, version, plan and region that can be ordered, with their specifications. Use clusterId with action and target to get the options available for an existing service, for example the plans it can be updated to.
Path parameters
Project ID
Query parameters
Filter availabilities by action type
FORKREADUPDATERestrict availabilities to a specific cluster
Filter availabilities by target type
FLAVORPLANSELFVERSIONHeaders
Pagination cursor
Pagination size
Response
Backup strategy for this availability
Category of the engine (database or analytics)
ANALYTICSDATABASEWhether this availability can be used by default
Database engine name
CLICKHOUSEGRAFANAKAFKAKAFKA_CONNECTKAFKA_MIRROR_MAKERMONGODBMYSQLOPENSEARCHPOSTGRESQLVALKEYLifecycle information
Plan name
Billing plan code
Billing plan code for storage
Region name
af-north-lz-rbaap-south-mumap-southeast-sgpap-southeast-sydca-east-bhsca-east-toreu-central-lz-buheu-central-lz-prgeu-central-lz-sofeu-central-waweu-north-lz-cpheu-north-lz-heleu-north-lz-osleu-north-lz-stoeu-south-lz-liseu-south-lz-madeu-south-lz-mileu-south-mileu-west-erieu-west-graeu-west-gra-snceu-west-limeu-west-lz-amseu-west-lz-brueu-west-lz-dlneu-west-lz-luxeu-west-lz-mnceu-west-lz-mrseu-west-lz-vieeu-west-lz-zrheu-west-pareu-west-rbxeu-west-rbx-snceu-west-sbgeu-west-sbg-sncus-central-lz-slcus-central-lz-stlus-east-lz-atlus-east-lz-bosus-east-lz-chius-east-lz-dalus-east-lz-miaus-east-lz-nycus-east-vinus-west-hilus-west-lz-denus-west-lz-laxus-west-lz-paous-west-lz-phxus-west-lz-seaTechnical specifications
Version name
Example uses projectId = string
$ curl https:/[ { "backups": { "available": true, "retentionDays": 0 }, "category": "ANALYTICS", "default": true, "engine": "CLICKHOUSE", "lifecycle": { "endOfLifeAt": "2024-01-01", "endOfSaleAt": "2024-01-01", "startedAt": "2024-01-01", "status": "BETA" }, "plan": "string", "planCode": "string", "planCodeStorage": "string", "region": "af-north-lz-rba", "specifications": { "flavor": "string", "network": "PRIVATE", "nodes": { "maximum": 0, "minimum": 0 }, "storage": { "maximum": { "unit": "GB", "value": 0 }, "minimum": { "unit": "GB", "value": 0 }, "step": { "unit": "GB", "value": 0 } } }, "version": "string" }]
List Analytics availability suggestionsBeta
Returns suggested combinations of Analytics engine, version, plan, flavor and region. The default suggestion is marked.
Path parameters
Project ID
Headers
Pagination cursor
Pagination size
Response
Whether this suggestion is the default
Engine name
CLICKHOUSEGRAFANAKAFKAKAFKA_CONNECTKAFKA_MIRROR_MAKERMONGODBMYSQLOPENSEARCHPOSTGRESQLVALKEYFlavor name
Plan name
Region name
af-north-lz-rbaap-south-mumap-southeast-sgpap-southeast-sydca-east-bhsca-east-toreu-central-lz-buheu-central-lz-prgeu-central-lz-sofeu-central-waweu-north-lz-cpheu-north-lz-heleu-north-lz-osleu-north-lz-stoeu-south-lz-liseu-south-lz-madeu-south-lz-mileu-south-mileu-west-erieu-west-graeu-west-gra-snceu-west-limeu-west-lz-amseu-west-lz-brueu-west-lz-dlneu-west-lz-luxeu-west-lz-mnceu-west-lz-mrseu-west-lz-vieeu-west-lz-zrheu-west-pareu-west-rbxeu-west-rbx-snceu-west-sbgeu-west-sbg-sncus-central-lz-slcus-central-lz-stlus-east-lz-atlus-east-lz-bosus-east-lz-chius-east-lz-dalus-east-lz-miaus-east-lz-nycus-east-vinus-west-hilus-west-lz-denus-west-lz-laxus-west-lz-paous-west-lz-phxus-west-lz-seaVersion name
Example uses projectId = string
$ curl https:/[ { "default": true, "engine": "CLICKHOUSE", "flavor": "string", "plan": "string", "region": "af-north-lz-rba", "version": "string" }]
List Analytics enginesBeta
Returns the available Analytics engines with their versions, default version and supported TLS modes.
Path parameters
Project ID
Headers
Pagination cursor
Pagination size
Response
Category of the engine (database or analytics)
ANALYTICSDATABASEVersion used when no version is specified at service creation
Human-readable description of the engine
Lifecycle information of the engine
Engine name
Display order
Supported TLS modes for connections
Storage strategy of the engine
DISTRIBUTEDNOT_APPLICABLEREPLICATEDDisplay tags
Versions available for this engine
Example uses projectId = string
$ curl https:/[ { "category": "ANALYTICS", "defaultVersion": "string", "description": "string", "lifecycle": { "endOfLifeAt": "2024-01-01", "endOfSaleAt": "2024-01-01", "startedAt": "2024-01-01", "status": "BETA" }, "name": "string", "order": 0, "sslModes": [ "string" ], "storage": "DISTRIBUTED", "tags": [ "string" ], "versions": [ { "default": true, "lifecycle": { "endOfLifeAt": "2024-01-01", "endOfSaleAt": "2024-01-01", "startedAt": "2024-01-01", "status": "BETA" }, "name": "string", "tags": [ "string" ] } ] }]
List Analytics regionsBeta
Returns the regions available for Analytics services, with their type and lifecycle.
Path parameters
Project ID
Headers
Pagination cursor
Pagination size
Response
Lifecycle information of the region
Name of the region
Display order
Display tags
Type of the region
LOCAL-ZONEREGION-1-AZREGION-3-AZExample uses projectId = string
$ curl https:/[ { "lifecycle": { "endOfLifeAt": "2024-01-01", "endOfSaleAt": "2024-01-01", "startedAt": "2024-01-01", "status": "BETA" }, "name": "string", "order": 0, "tags": [ "string" ], "type": "LOCAL-ZONE" }]
List Analytics plansBeta
Returns the plans available for Analytics services, with their description and automatic backup retention.
Path parameters
Project ID
Headers
Pagination cursor
Pagination size
Response
Automatic backup retention duration
Description of the plan
Lifecycle information of the plan
Name of the plan
Display order
Display tags
Example uses projectId = string
$ curl https:/[ { "backupRetention": "string", "description": "string", "lifecycle": { "endOfLifeAt": "2024-01-01", "endOfSaleAt": "2024-01-01", "startedAt": "2024-01-01", "status": "BETA" }, "name": "string", "order": 0, "tags": [ "string" ] }]
List Analytics flavorsBeta
Returns the compute flavors available for Analytics services, with their technical specifications and lifecycle.
Path parameters
Project ID
Headers
Pagination cursor
Pagination size
Response
Generation tag used to group flavors in the order funnel
GEN1GEN2GEN3Lifecycle information of the flavor
Name of the flavor
Display order
Technical specifications
Display tags
Example uses projectId = string
$ curl https:/[ { "generation": "GEN1", "lifecycle": { "endOfLifeAt": "2024-01-01", "endOfSaleAt": "2024-01-01", "startedAt": "2024-01-01", "status": "BETA" }, "name": "string", "order": 0, "specifications": { "memory": { "unit": "GB", "value": 0 }, "vcpus": 0 }, "tags": [ "string" ] }]
List Analytics disk typesBeta
Returns the disk types available for Analytics services, with their IOPS and throughput specifications.
Path parameters
Project ID
Headers
Pagination cursor
Pagination size
Response
Number of IOPS per GB of disk. Null when IOPS are fixed regardless of disk size.
Maximum IOPS per volume
Maximum throughput in MB/s per volume. Null when no throughput limit applies.
Name of the disk type
Throughput in MB/s per GB of disk. Null when no throughput scaling applies.
Example uses projectId = string
$ curl https:/[ { "iopsPerGigabyte": 0, "maximumIops": 0, "maximumThroughput": 0, "name": "string", "throughputPerGigabyte": 0 }]
List Analytics optionsBeta
Returns the options available for Analytics services and their data type.
Path parameters
Project ID
Headers
Pagination cursor
Pagination size
Response
Name of the option
Data type of the option
BOOLEANDOUBLEDURATIONLONGSTRINGExample uses projectId = string
$ curl https:/[ { "name": "string", "type": "BOOLEAN" }]