usage_forecasts

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

Overview

Name	usage_forecasts
Type	Resource
Id	ovh.cloud.usage_forecasts

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
hourly_usage	object	Hourly forecast (wire: hourlyUsage)
last_update	string (date-time)	Entry last update (wire: lastUpdate)
monthly_usage	object	Monthly forecast (wire: monthlyUsage)
period	object	Forecast dates (from/to)
resources_usage	array	Resource usage forecast (billed per hour/minute/second/unit) (wire: resourcesUsage)
total_price	object	Total price (wire: totalPrice)
usable_credits	object	Usable credit to pay next bill (wire: usableCredits)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Returns the forecast usage and price of the project at the end of the current month, and the credits that can pay the next bill.

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"}})
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.

SELECT examples

get

Returns the forecast usage and price of the project at the end of the current month, and the credits that can pay the next bill.

SELECT
hourly_usage,
last_update,
monthly_usage,
period,
resources_usage,
total_price,
usable_credits
FROM ovh.cloud.usage_forecasts
WHERE service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;