Skip to main content

monitoring_generic_incident_partners

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

Overview​

Namemonitoring_generic_incident_partners
TypeResource
Idovh.connectivity.monitoring_generic_incident_partners

Fields​

The following fields are returned by SELECT queries:

Generic incident structure

NameDatatypeDescription
idintegerGeneric incident id
task_idintegerTask id (wire: taskId)
commentstringOptional comment, that contains some information and updates about the generic incident
creation_datestringCreation date, the generic incident has been detected (wire: creationDate)
defaultstringType of fault
departmentsarrayList of impacted department codes
end_datestringEnd date, the generic incident is resolved and closed (wire: endDate)
estimated_resolution_datestringEstimated resolution date for generic incident (wire: estimatedResolutionDate)
is_nationalbooleanIdentify a national generic incident (wire: isNational)
naturestringDetails about the consequence of the default
nraarrayList of impacted NRA/NRO
operatorsarrayList of impacted operators
statusstringGeneric incident status (closed, detected, validated)
task_referencestringTask reference created on Ovhcloud status web page (wire: taskReference)
technologiesarrayImpacted technologies

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectcreation_date, end_date, statusReturns the detected, validated and recently closed generic incidents, with their impacted operators, technologies, NRA/NRO and departments, and their estimated resolution date. Reserved for partners.

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.

NameDatatypeDescription
api_hoststringThe 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"}})
creation_datestring (date-time)List only incidents created after this date (wire: creationDate)
end_datestring (date-time)List only incidents closed prior to this date (wire: endDate)
statusstringFilter by the status of the incident (detected, validated or closed)

SELECT examples​

Returns the detected, validated and recently closed generic incidents, with their impacted operators, technologies, NRA/NRO and departments, and their estimated resolution date. Reserved for partners.

SELECT
id,
task_id,
comment,
creation_date,
default,
departments,
end_date,
estimated_resolution_date,
is_national,
nature,
nra,
operators,
status,
task_reference,
technologies
FROM ovh.connectivity.monitoring_generic_incident_partners
WHERE creation_date = '{{ creation_date }}'
AND end_date = '{{ end_date }}'
AND status = '{{ status }}'
;