incidents
Creates, updates, deletes, gets or lists an incidents resource.
Overview​
| Name | incidents |
| Type | Resource |
| Id | ovh.ovh_cloud_connect.incidents |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | integer | Incident reference |
end_date | string (date-time) | Ending date of the incident (wire: endDate) |
start_date | string (date-time) | Starting date of the incident (wire: startDate) |
type | string | Type of incident (incident, maintenance) |
OVHcloud Connect Incident
| Name | Datatype | Description |
|---|---|---|
id | integer | Incident reference |
end_date | string (date-time) | Ending date of the incident (wire: endDate) |
start_date | string (date-time) | Starting date of the incident (wire: startDate) |
type | string | Type of incident (incident, maintenance) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | id, service_name | Returns whether it is an incident or a maintenance, with its start and end dates. | |
list | select | service_name | x_pagination_mode | Returns the IDs of the incidents and planned maintenances affecting the service. |
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 (uuid) | Service name (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
- list
Returns whether it is an incident or a maintenance, with its start and end dates.
SELECT
id,
end_date,
start_date,
type
FROM ovh.ovh_cloud_connect.incidents
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;
Returns the IDs of the incidents and planned maintenances affecting the service.
SELECT
id,
end_date,
start_date,
type
FROM ovh.ovh_cloud_connect.incidents
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;