Skip to main content

availabilities_raws

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

Overview​

Nameavailabilities_raws
TypeResource
Idovh.dedicated_cluster.availabilities_raws

Fields​

The following fields are returned by SELECT queries:

Cluster availability

NameDatatypeDescription
cluster_plan_codestringPlan code in which the hardware is involved (wire: clusterPlanCode)
fqnstringFully qualified name and unique name of the hardware
memorystringName of the memory hardware part
plan_codestringPlan code in which the hardware is involved (wire: planCode)
regionsarrayA structure describing the hardware availability for each region
serverstringName of the base hardware
storagestringName of the storage hardware part
system_storagestringName of the system storage hardware part (wire: systemStorage)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectquantityexclude_regions, memory, plan_code, regions, server, storage, system_storageReturns the raw availability of cluster hardware: for each region, the real stock, the real stock including parent references, and the last rule applied. Filter by quantity, hardware parts, plan code and regions, and set excludeRegions to return every region except those listed. (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.

NameDatatypeDescription
api_hoststringThe 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"}})
quantityintegerNode quantity
exclude_regionsbooleanIf true, all regions are returned except those listed in regions parameter (wire: excludeRegions)
memorystringThe name of the memory hardware part
plan_codestringThe plan code in which the hardware is involved (wire: planCode)
regionsstringThe names of regions separated by commas
serverstringThe name of the base hardware
storagestringThe name of the storage hardware part
system_storagestringThe name of the system storage hardware part (wire: systemStorage)

SELECT examples​

Returns the raw availability of cluster hardware: for each region, the real stock, the real stock including parent references, and the last rule applied. Filter by quantity, hardware parts, plan code and regions, and set excludeRegions to return every region except those listed. (Beta version)

SELECT
cluster_plan_code,
fqn,
memory,
plan_code,
regions,
server,
storage,
system_storage
FROM ovh.dedicated_cluster.availabilities_raws
WHERE quantity = '{{ quantity }}' -- required
AND exclude_regions = '{{ exclude_regions }}'
AND memory = '{{ memory }}'
AND plan_code = '{{ plan_code }}'
AND regions = '{{ regions }}'
AND server = '{{ server }}'
AND storage = '{{ storage }}'
AND system_storage = '{{ system_storage }}'
;