availabilities

Creates, updates, deletes, gets or lists an availabilities resource.

Overview

Name	availabilities
Type	Resource
Id	ovh.public_cloud_database.availabilities

Fields

The following fields are returned by SELECT queries:

list

Availability of a database engine configuration

Name	Datatype	Description
backups	object	Backup strategy for this availability
category	string	Category of the engine (database or analytics) (ANALYTICS, DATABASE)
default	boolean	Whether this availability can be used by default
engine	string	Database engine name (CLICKHOUSE, GRAFANA, KAFKA, KAFKA_CONNECT, KAFKA_MIRROR_MAKER, MONGODB, MYSQL, OPENSEARCH, POSTGRESQL, VALKEY)
lifecycle	object	Lifecycle information
plan	string	Plan name
plan_code	string	Billing plan code (wire: planCode)
plan_code_storage	string	Billing plan code for storage (wire: planCodeStorage)
region	string	Region name (af-north-lz-rba, ap-south-mum, ap-southeast-sgp, ap-southeast-syd, ca-east-bhs, ca-east-tor, eu-central-lz-buh, eu-central-lz-prg, eu-central-lz-sof, eu-central-waw, eu-north-lz-cph, eu-north-lz-hel, eu-north-lz-osl, eu-north-lz-sto, eu-south-lz-lis, eu-south-lz-mad, eu-south-lz-mil, eu-south-mil, eu-west-eri, eu-west-gra, eu-west-gra-snc, eu-west-lim, eu-west-lz-ams, eu-west-lz-bru, eu-west-lz-dln, eu-west-lz-lux, eu-west-lz-mnc, eu-west-lz-mrs, eu-west-lz-vie, eu-west-lz-zrh, eu-west-par, eu-west-rbx, eu-west-rbx-snc, eu-west-sbg, eu-west-sbg-snc, us-central-lz-slc, us-central-lz-stl, us-east-lz-atl, us-east-lz-bos, us-east-lz-chi, us-east-lz-dal, us-east-lz-mia, us-east-lz-nyc, us-east-vin, us-west-hil, us-west-lz-den, us-west-lz-lax, us-west-lz-pao, us-west-lz-phx, us-west-lz-sea)
specifications	object	Technical specifications
version	string	Version name

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	project_id	x_pagination_cursor, x_pagination_size, action, cluster_id, target	Returns the combinations of Databases 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. (Beta version)

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
action	string	Filter availabilities by action type
cluster_id	string (uuid)	Restrict availabilities to a specific cluster (wire: clusterId)
target	string	Filter availabilities by target type
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

list

Returns the combinations of Databases 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. (Beta version)

SELECT
backups,
category,
default,
engine,
lifecycle,
plan,
plan_code,
plan_code_storage,
region,
specifications,
version
FROM ovh.public_cloud_database.availabilities
WHERE project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND action = '{{ action }}'
AND cluster_id = '{{ cluster_id }}'
AND target = '{{ target }}'
;