catalog_formatted_web_hostings
Creates, updates, deletes, gets or lists a catalog_formatted_web_hostings resource.
Overview​
| Name | catalog_formatted_web_hostings |
| Type | Resource |
| Id | ovh.order.catalog_formatted_web_hostings |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
count | integer | Number of offers in this page |
pagination | array | List of the available page numbers |
plans | array | Web hosting offers of this page |
total | integer | Total number of offers matching the filters |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | ovh_subsidiary | count, offset, plan_codes | Web hosting offers of the public catalog for a subsidiary, as the website's product cards show them: advertised monthly price, promotional first term and renewal price, every billing term, the prices per commitment (12, 24 or 48 months) with the saving on the shortest one, commercial features, technical specifications and order funnel link. Plan code filter 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) |
count | integer | Number of results per page. Defaults to 25 |
offset | integer | Offset of the first result returned, used with count for pagination |
plan_codes | string | Return only the offers with these plan codes, comma-separated (e.g. hosting-starter,hosting-perso) (wire: planCodes) |
SELECT examples​
- get
Web hosting offers of the public catalog for a subsidiary, as the website's product cards show them: advertised monthly price, promotional first term and renewal price, every billing term, the prices per commitment (12, 24 or 48 months) with the saving on the shortest one, commercial features, technical specifications and order funnel link. Plan code filter and pagination.
SELECT
count,
pagination,
plans,
total
FROM ovh.order.catalog_formatted_web_hostings
WHERE ovh_subsidiary = '{{ ovh_subsidiary }}' -- required
AND count = '{{ count }}'
AND offset = '{{ offset }}'
AND plan_codes = '{{ plan_codes }}'
;