incidents

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

Overview

Name	incidents
Type	Resource
Id	ovh.xdsl.incidents

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	ID of the incident
task_id	integer	Task ID on travaux.ovh.com (wire: taskId)
comment	string
creation_date	string (date-time)	Estimated start date (wire: creationDate)
departments	array	Department list
end_date	string (date-time)	Estimated end date (wire: endDate)
nra	array	NRA list
operators	array	Operator
task_reference	string	(wire: taskReference)

get_by_service_name

successful operation

Name	Datatype	Description
id	integer	ID of the incident
task_id	integer	Task ID on travaux.ovh.com (wire: taskId)
comment	string
creation_date	string (date-time)	Estimated start date (wire: creationDate)
departments	array	Department list
end_date	string (date-time)	Estimated end date (wire: endDate)
nra	array	NRA list
operators	array	Operator
task_reference	string	(wire: taskReference)

list

Detected incident

Name	Datatype	Description
id	integer	ID of the incident
task_id	integer	Task ID on travaux.ovh.com (wire: taskId)
comment	string
creation_date	string (date-time)	Estimated start date (wire: creationDate)
departments	array	Department list
end_date	string (date-time)	Estimated end date (wire: endDate)
nra	array	NRA list
operators	array	Operator
task_reference	string	(wire: taskReference)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id		Returns an incident with its estimated start and end dates, impacted operators, NRA and departments, and comment.
get_by_service_name	select	service_name		Returns the generic incident that impacts the access, if any, with its estimated start and end dates, operators, NRA and departments.
list	select		creation_date, end_date, x_pagination_mode	Returns the IDs of the incidents impacting xDSL accesses. Filter on the creation and end dates.

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
service_name	string	Service name (wire: serviceName)
creation_date	string (date-time)	Filter the value of creationDate property (>) (wire: creationDate)
end_date	string (date-time)	Filter the value of endDate property (<) (wire: endDate)
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

Returns an incident with its estimated start and end dates, impacted operators, NRA and departments, and comment.

SELECT
id,
task_id,
comment,
creation_date,
departments,
end_date,
nra,
operators,
task_reference
FROM ovh.xdsl.incidents
WHERE id = '{{ id }}' -- required
;

get_by_service_name

Returns the generic incident that impacts the access, if any, with its estimated start and end dates, operators, NRA and departments.

SELECT
id,
task_id,
comment,
creation_date,
departments,
end_date,
nra,
operators,
task_reference
FROM ovh.xdsl.incidents
WHERE service_name = '{{ service_name }}' -- required
;

list

Returns the IDs of the incidents impacting xDSL accesses. Filter on the creation and end dates.

SELECT
id,
task_id,
comment,
creation_date,
departments,
end_date,
nra,
operators,
task_reference
FROM ovh.xdsl.incidents
WHERE creation_date = '{{ creation_date }}'
AND end_date = '{{ end_date }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;