statistics
Creates, updates, deletes, gets or lists a statistics resource.
Overview​
| Name | statistics |
| Type | Resource |
| Id | ovh.xdsl.statistics |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
unit | string | |
values | array |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | period, service_name, type | Returns the ping or download and upload traffic values of the access over a daily, weekly, monthly or yearly period, with their unit. |
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"}}) |
period | string | |
service_name | string | Service name (wire: serviceName) |
type | string |
SELECT examples​
- get
Returns the ping or download and upload traffic values of the access over a daily, weekly, monthly or yearly period, with their unit.
SELECT
unit,
values
FROM ovh.xdsl.statistics
WHERE period = '{{ period }}' -- required
AND service_name = '{{ service_name }}' -- required
AND type = '{{ type }}' -- required
;