catalog_formatted_private_clouds
Creates, updates, deletes, gets or lists a catalog_formatted_private_clouds resource.
Overview​
| Name | catalog_formatted_private_clouds |
| Type | Resource |
| Id | ovh.order.catalog_formatted_private_clouds |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
catalog_id | string | Catalog ID (wire: catalogId) |
catalog_name | string | Catalog name (wire: catalogName) |
active | boolean | Describe if a catalog is Active |
commercial_ranges | array | Describes Commercial Ranges of a Dedicated Cloud (wire: commercialRanges) |
merchant_code | string | OVH Subsidiary of the Catalog (wire: merchantCode) |
plans | array | Commercial offers |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | ovh_subsidiary | Retrieve 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.
| 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 | Subsidiary of the country you want to consult catalog (wire: ovhSubsidiary) |
SELECT examples​
- get
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
;