order_consumption_details

Creates, updates, deletes, gets or lists an order_consumption_details resource.

Overview

Name	order_consumption_details
Type	Resource
Id	ovh.me.order_consumption_details

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_id	integer	Consumption details export task's identifier (wire: taskId)
file_format	string	Format of the file (csv) (wire: fileFormat)
file_url	string	Temporary URL to download detailed consumption (wire: fileURL)
message	string	Request's state description
task_status	string	Consumption details export task's status (DOING, DONE, ERROR, TODO) (wire: taskStatus)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	file_format, order_id		Retrieve order's detailed consumption information as a file

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"}})
file_format	string	Format of the file (wire: fileFormat)
order_id	integer	(wire: orderId)

SELECT examples

get

Retrieve order's detailed consumption information as a file

SELECT
task_id,
file_format,
file_url,
message,
task_status
FROM ovh.me.order_consumption_details
WHERE file_format = '{{ file_format }}' -- required
AND order_id = '{{ order_id }}' -- required
;