interface_statistics

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

Overview

Name	interface_statistics
Type	Resource
Id	ovh.ovh_cloud_connect.interface_statistics

Fields

The following fields are returned by SELECT queries:

list

OVHcloud Connect Metrics

Name	Datatype	Description
timestamp	integer	timestamp corresponding to the value
value	object	OVHcloud Connect Metrics value

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	id, period, service_name, type		Returns a time series of traffic, errors or optical levels for the chosen period.

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"}})
id	integer	Id
period	string	The period the statistics are fetched for
service_name	string (uuid)	Service name (wire: serviceName)
type	string	The type of statistic to be fetched

SELECT examples

list

Returns a time series of traffic, errors or optical levels for the chosen period.

SELECT
timestamp,
value
FROM ovh.ovh_cloud_connect.interface_statistics
WHERE id = '{{ id }}' -- required
AND period = '{{ period }}' -- required
AND service_name = '{{ service_name }}' -- required
AND type = '{{ type }}' -- required
;