catalog_formatted_baremetal_servers
Creates, updates, deletes, gets or lists a catalog_formatted_baremetal_servers resource.
Overview​
| Name | catalog_formatted_baremetal_servers |
| Type | Resource |
| Id | ovh.order.catalog_formatted_baremetal_servers |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
count | integer | Number of servers in this page |
display | object | How the subsidiary's prices are put forward on the website |
pagination | array | List of the available page numbers |
servers | array | Servers of this page |
total | integer | Total number of servers matching the filters |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | ovh_subsidiary | cores_max, cores_min, count, cpu_brands, datacenters, freq_max, freq_min, merge_generations, offset, os_available, plan_codes, price_max, price_min, private_bw_max, private_bw_min, public_bw_max, public_bw_min, ram_max, ram_min, ranges, sockets, sort, storage_max, storage_min, storage_raid, storage_types, threads_max, threads_min, use_cases, with_gpu | Bare-metal dedicated servers of the public catalog for a subsidiary: one product per commercial server (its newest hardware generation by default, mergeGenerations=false lists every generation) with the specs of its default configuration, the ranges of its options and one price per datacenter, with hardware, network, price and range filters, sorting and pagination. Text specs and prices follow the website's typography for the subsidiary. |
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) |
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 |
freq_max | number | Maximum CPU frequency, in GHz (wire: freqMax) |
freq_min | number | Minimum CPU frequency, in GHz (wire: freqMin) |
merge_generations | boolean | Fold the hardware generations of a model into one server, the newest one extended with the datacenters only older generations still serve. Default to true; false lists every generation (wire: mergeGenerations) |
offset | integer | Offset of the first result returned, used with count for pagination |
os_available | array | Filter on available operating systems. Repeat the parameter for multiple values (wire: osAvailable) |
plan_codes | string | Return only the servers with these plan codes, comma-separated (e.g. 25rise01,25adv01), matched case-insensitively (wire: planCodes) |
price_max | number | Maximum monthly price, in the subsidiary currency (e.g. 499.99) (wire: priceMax) |
price_min | number | Minimum monthly price, in the subsidiary currency (e.g. 99.99) (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 |
sockets | array | Filter on the number of CPU sockets. Repeat the parameter for multiple values |
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_raid | array | Filter on RAID levels of the default storage configuration. Repeat the parameter for multiple values (wire: storageRaid) |
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) |
with_gpu | boolean | Filter on servers with (true) or without (false) a GPU (wire: withGpu) |
SELECT examples​
- get
Bare-metal dedicated servers of the public catalog for a subsidiary: one product per commercial server (its newest hardware generation by default, mergeGenerations=false lists every generation) with the specs of its default configuration, the ranges of its options and one price per datacenter, with hardware, network, price and range filters, sorting and pagination. Text specs and prices follow the website's typography for the subsidiary.
SELECT
count,
display,
pagination,
servers,
total
FROM ovh.order.catalog_formatted_baremetal_servers
WHERE ovh_subsidiary = '{{ ovh_subsidiary }}' -- required
AND cores_max = '{{ cores_max }}'
AND cores_min = '{{ cores_min }}'
AND count = '{{ count }}'
AND cpu_brands = '{{ cpu_brands }}'
AND datacenters = '{{ datacenters }}'
AND freq_max = '{{ freq_max }}'
AND freq_min = '{{ freq_min }}'
AND merge_generations = '{{ merge_generations }}'
AND offset = '{{ offset }}'
AND os_available = '{{ os_available }}'
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 sockets = '{{ sockets }}'
AND sort = '{{ sort }}'
AND storage_max = '{{ storage_max }}'
AND storage_min = '{{ storage_min }}'
AND storage_raid = '{{ storage_raid }}'
AND storage_types = '{{ storage_types }}'
AND threads_max = '{{ threads_max }}'
AND threads_min = '{{ threads_min }}'
AND use_cases = '{{ use_cases }}'
AND with_gpu = '{{ with_gpu }}'
;