catalog_formatted_ecos

Creates, updates, deletes, gets or lists a catalog_formatted_ecos resource.

Overview

Name	catalog_formatted_ecos
Type	Resource
Id	ovh.order.catalog_formatted_ecos

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
count	integer	Number of servers (or references when groupBy=reference) in this page
display	object	How the subsidiary's prices are put forward on the website
facets	object	Values available for the interactive filters, computed on the matching servers. Only when groupBy=reference
pagination	array	List of the available page numbers
references	array	Commercial references of this page, each grouping its server variants. Only when groupBy=reference
servers	array	Servers of this page. Absent when groupBy=reference
total	integer	Total number of servers (or references when groupBy=reference) matching the filters

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	ovh_subsidiary	availability, cores_max, cores_min, count, cpu_brands, datacenters, exclude, freq_max, freq_min, group_by, offset, plan_codes, price_max, price_min, private_bw_max, private_bw_min, public_bw_max, public_bw_min, ram_max, ram_min, ranges, score_max, score_min, sort, storage_max, storage_min, storage_types, threads_max, threads_min, use_cases	Servers of the public eco catalog for a subsidiary, cross-checked against datacenter availability, with interactive filters, optional grouping by commercial reference (groupBy=reference), sorting and pagination.

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"}})
ovh_subsidiary	string	OVHcloud subsidiary targeted (wire: ovhSubsidiary)
availability	string	Servers to list: available (default) lists the orderable ones; all also lists the sold-out and coming-soon ones, each tagged with its availability
cores_max	integer	Maximum number of CPU cores (wire: coresMax)
cores_min	integer	Minimum number of CPU cores (wire: coresMin)
count	integer	Number of results per page. Default to 20
cpu_brands	array	Filter on CPU brands (e.g. Intel, AMD). Repeat the parameter for multiple values (wire: cpuBrands)
datacenters	array	Filter on datacenters where the server is available. Repeat the parameter for multiple values
exclude	array	Response sections to exclude to lighten the response (e.g. variants)
freq_max	number	Maximum CPU frequency, in GHz (wire: freqMax)
freq_min	number	Minimum CPU frequency, in GHz (wire: freqMin)
group_by	string	Group the servers by commercial reference. Only allowed value: reference (wire: groupBy)
offset	integer	Offset of the first result returned, used with count for pagination
plan_codes	string	Return only the servers with these plan codes, comma-separated (e.g. 24skgame012-syd,24sk202) (wire: planCodes)
price_max	number	Maximum monthly price (wire: priceMax)
price_min	number	Minimum monthly price (wire: priceMin)
private_bw_max	integer	Maximum private bandwidth, in Mbps (wire: privateBwMax)
private_bw_min	integer	Minimum private bandwidth, in Mbps (wire: privateBwMin)
public_bw_max	integer	Maximum public bandwidth, in Mbps (wire: publicBwMax)
public_bw_min	integer	Minimum public bandwidth, in Mbps (wire: publicBwMin)
ram_max	integer	Maximum RAM size, in GB (wire: ramMax)
ram_min	integer	Minimum RAM size, in GB (wire: ramMin)
ranges	array	Filter on commercial ranges. Repeat the parameter for multiple values
score_max	integer	Maximum CPU benchmark score (wire: scoreMax)
score_min	integer	Minimum CPU benchmark score (wire: scoreMin)
sort	string	Sort order: price-asc (default), price-desc, name-asc or name-desc. Servers with a promotion always come first
storage_max	number	Maximum storage size, in GB (wire: storageMax)
storage_min	number	Minimum storage size, in GB (wire: storageMin)
storage_types	array	Filter on storage types. Repeat the parameter for multiple values (wire: storageTypes)
threads_max	integer	Maximum number of CPU threads (wire: threadsMax)
threads_min	integer	Minimum number of CPU threads (wire: threadsMin)
use_cases	array	Filter on server use cases. Repeat the parameter for multiple values (wire: useCases)

SELECT examples

get

Servers of the public eco catalog for a subsidiary, cross-checked against datacenter availability, with interactive filters, optional grouping by commercial reference (groupBy=reference), sorting and pagination.

SELECT
count,
display,
facets,
pagination,
references,
servers,
total
FROM ovh.order.catalog_formatted_ecos
WHERE ovh_subsidiary = '{{ ovh_subsidiary }}' -- required
AND availability = '{{ availability }}'
AND cores_max = '{{ cores_max }}'
AND cores_min = '{{ cores_min }}'
AND count = '{{ count }}'
AND cpu_brands = '{{ cpu_brands }}'
AND datacenters = '{{ datacenters }}'
AND exclude = '{{ exclude }}'
AND freq_max = '{{ freq_max }}'
AND freq_min = '{{ freq_min }}'
AND group_by = '{{ group_by }}'
AND offset = '{{ offset }}'
AND plan_codes = '{{ plan_codes }}'
AND price_max = '{{ price_max }}'
AND price_min = '{{ price_min }}'
AND private_bw_max = '{{ private_bw_max }}'
AND private_bw_min = '{{ private_bw_min }}'
AND public_bw_max = '{{ public_bw_max }}'
AND public_bw_min = '{{ public_bw_min }}'
AND ram_max = '{{ ram_max }}'
AND ram_min = '{{ ram_min }}'
AND ranges = '{{ ranges }}'
AND score_max = '{{ score_max }}'
AND score_min = '{{ score_min }}'
AND sort = '{{ sort }}'
AND storage_max = '{{ storage_max }}'
AND storage_min = '{{ storage_min }}'
AND storage_types = '{{ storage_types }}'
AND threads_max = '{{ threads_max }}'
AND threads_min = '{{ threads_min }}'
AND use_cases = '{{ use_cases }}'
;