line_traffic_extracts

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

Overview

Name	line_traffic_extracts
Type	Resource
Id	ovh.telephony.line_traffic_extracts

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	The id of the traffic extract
date_end	string (date-time)	The start date of the traffic extract (wire: dateEnd)
date_start	string (date-time)	The start date of the traffic extract (wire: dateStart)
file_size	integer	The PCAP file size of the traffic extract (wire: fileSize)
file_url	string	The PCAP URL of the traffic extract (wire: fileUrl)
status	string	The status of the extract (doing, done, error, pause, todo)

list

Traffic extracts (SIP) of your line

Name	Datatype	Description
id	integer	The id of the traffic extract
date_end	string (date-time)	The start date of the traffic extract (wire: dateEnd)
date_start	string (date-time)	The start date of the traffic extract (wire: dateStart)
file_size	integer	The PCAP file size of the traffic extract (wire: fileSize)
file_url	string	The PCAP URL of the traffic extract (wire: fileUrl)
status	string	The status of the extract (doing, done, error, pause, todo)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, id, service_name		Get a traffic extract
list	select	billing_account, service_name	x_pagination_mode	List traffic extracts
create	insert	billing_account, service_name, date_end, date_start		Start a traffic extract
delete	delete	billing_account, id, service_name		Delete a traffic extract

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"}})
billing_account	string	The name of your billingAccount (wire: billingAccount)
id	integer	Id of the object
service_name	string	(wire: serviceName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a traffic extract

SELECT
id,
date_end,
date_start,
file_size,
file_url,
status
FROM ovh.telephony.line_traffic_extracts
WHERE billing_account = '{{ billing_account }}' -- required
AND id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List traffic extracts

SELECT
id,
date_end,
date_start,
file_size,
file_url,
status
FROM ovh.telephony.line_traffic_extracts
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Start a traffic extract

INSERT INTO ovh.telephony.line_traffic_extracts (
date_end,
date_start,
billing_account,
service_name
)
SELECT 
'{{ date_end }}' /* required */,
'{{ date_start }}' /* required */,
'{{ billing_account }}',
'{{ service_name }}'
RETURNING
id,
date_end,
date_start,
file_size,
file_url,
status
;

Manifest

# Description fields are for documentation purposes
- name: line_traffic_extracts
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the line_traffic_extracts resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the line_traffic_extracts resource.
  - name: date_end
    value: "{{ date_end }}"
    description: |
      The end date of the traffic extract
  - name: date_start
    value: "{{ date_start }}"
    description: |
      The start date of the traffic extract

DELETE examples

delete

Delete a traffic extract

DELETE FROM ovh.telephony.line_traffic_extracts
WHERE billing_account = '{{ billing_account }}' --required
AND id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required
;