images_availables

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

Overview

Name	images_availables
Type	Resource
Id	ovh.vps.images_availables

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string
name	string

list

Installation image for a VPS

Name	Datatype	Description
id	string
name	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Returns the name, distribution and version of an image that can be installed on the VPS. (Beta version)
list	select	service_name	x_pagination_mode	Returns the names of the images that can be installed on the VPS. (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"}})
id	string	Id
service_name	string	Service name (wire: serviceName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Returns the name, distribution and version of an image that can be installed on the VPS. (Beta version)

SELECT
id,
name
FROM ovh.vps.images_availables
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the names of the images that can be installed on the VPS. (Beta version)

SELECT
id,
name
FROM ovh.vps.images_availables
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;