Skip to main content

catalog_formatted_private_clouds

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

Overview​

Namecatalog_formatted_private_clouds
TypeResource
Idovh.order.catalog_formatted_private_clouds

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
catalog_idstringCatalog ID (wire: catalogId)
catalog_namestringCatalog name (wire: catalogName)
activebooleanDescribe if a catalog is Active
commercial_rangesarrayDescribes Commercial Ranges of a Dedicated Cloud (wire: commercialRanges)
merchant_codestringOVH Subsidiary of the Catalog (wire: merchantCode)
plansarrayCommercial offers

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectovh_subsidiaryRetrieve information of Dedicated Cloud catalog

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"}})
ovh_subsidiarystringSubsidiary of the country you want to consult catalog (wire: ovhSubsidiary)

SELECT examples​

Retrieve information of Dedicated Cloud catalog

SELECT
catalog_id,
catalog_name,
active,
commercial_ranges,
merchant_code,
plans
FROM ovh.order.catalog_formatted_private_clouds
WHERE ovh_subsidiary = '{{ ovh_subsidiary }}' -- required
;