availabilities

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

Overview

Name	availabilities
Type	Resource
Id	ovh.cloud_database.availabilities

Fields

The following fields are returned by SELECT queries:

list

Availability of databases engines on cloud projects

Name	Datatype	Description
backup	string	Defines the type of backup. DEPRECATED: use backups.enable (automatic, manual, none, pitr, snapshot)
backup_retention_days	integer	Backup retention time of the availability in days. DEPRECATED: use backups.retentionDays (wire: backupRetentionDays)
backups	object	Defines backups strategy for the availability
category	string	Category of the engine (analysis, operational, streaming)
default	boolean	Whether this availability can be used by default
end_of_life	string (date)	End of life of the product. DEPRECATED: use lifecycle.endOfLife (wire: endOfLife)
engine	string	Database engine name
flavor	string	Flavor name. DEPRECATED: use specifications.flavor
lifecycle	object	Defines the lifecycle of the availability
max_disk_size	integer	Maximum possible disk size in GB. DEPRECATED: use specifications.storage.maximum (wire: maxDiskSize)
max_node_number	integer	Maximum nodes of the cluster. DEPRECATED: use specifications.nodes.maximum (wire: maxNodeNumber)
min_disk_size	integer	Minimum possible disk size in GB. DEPRECATED: use specifications.storage.minimum (wire: minDiskSize)
min_node_number	integer	Minimum nodes of the cluster. DEPRECATED: use specifications.nodes.minimum (wire: minNodeNumber)
network	string	Type of network. DEPRECATED: use specifications.network (private, public)
plan	string	Plan name
plan_code	string	Billing plan code (wire: planCode)
plan_code_storage	string	Billing plan code for storage (wire: planCodeStorage)
plan_codes	object	Split pricing plan codes (wire: planCodes)
region	string	Region name
specifications	object	Defines the technical specifications of the availability
start_date	string (date)	Date of the release of the product. DEPRECATED: use lifecycle.startDate (wire: startDate)
status	string	Status of the availability. DEPRECATED: use lifecycle.status (BETA, DEPRECATED, END_OF_LIFE, END_OF_SALE, STABLE, UNAVAILABLE)
step_disk_size	integer	Flex disk size step in GB. DEPRECATED: use specifications.storage.step (wire: stepDiskSize)
upstream_end_of_life	string (date)	End of life of the upstream product. DEPRECATED: use lifecycle (wire: upstreamEndOfLife)
version	string	Version name

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	service_name	action, cluster_id, target	Get database engines availability

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"}})
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
action	string	Type of action on which restrict the availabilities
cluster_id	string (uuid)	Cluster ID on which restrict the availabilities (wire: clusterId)
target	string	Type of target on which restrict the availabilities

SELECT examples

list

Get database engines availability

SELECT
backup,
backup_retention_days,
backups,
category,
default,
end_of_life,
engine,
flavor,
lifecycle,
max_disk_size,
max_node_number,
min_disk_size,
min_node_number,
network,
plan,
plan_code,
plan_code_storage,
plan_codes,
region,
specifications,
start_date,
status,
step_disk_size,
upstream_end_of_life,
version
FROM ovh.cloud_database.availabilities
WHERE service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND action = '{{ action }}'
AND cluster_id = '{{ cluster_id }}'
AND target = '{{ target }}'
;