The monitoring service records changelogs for alarm statuses. Changelogs are accessible as a time series collection. When accessing a time series collection, two parameters beyond the base paginated collection API are available: from and to. For details, see Time Series Collection.
By default the API queries the last 7 days of changelog information.
Use the following changelogs API operations to view and manage changelogs.
List alarm changelogs
GET /changelogs/alarms
Lists alarm changelogs for this account.
The following table shows the possible response codes for this operation:
| Response Code | Name | Description |
|---|---|---|
| 200 | OK | The request completed. |
| 401 | Unauthorized | The system received a request from a user that is not authenticated. |
| 403 | Forbidden | The system received a request that the user is not authorized to make. |
| 500 | Internal Server Error | An unexpected condition was encountered. |
| 503 | Service Unavailable | The system is experiencing heavy load or another system failure. |
The following table shows the header parameters for the request:
| Name | Type | Description |
|---|---|---|
| X-Auth-Token | String (Required) | A valid authentication token with administrative access. For details, see Get your credentials |
Note
This operation does not accept a request body.
Example List alarm changelogs: JSON response
{
"values": [
{
"id": "4c5e28f0-0b3f-11e1-860d-c55c4705a286",
"timestamp": 1320890228991,
"entity_id": "enPhid7noo",
"alarm_id": "alahf9vuNa",
"check_id": "chIe7vohba",
"state": "WARNING",
"analyzed_by_monitoring_zone_id": "DFW"
}
],
"metadata": {
"count": 1,
"limit": 50,
"marker": null,
"next_marker": null,
"next_href": null
}
}
Get alarm changelogs by entity ID
GET /changelogs/alarms
Lists alarm changelogs for this account, filtered by entity ID.
Note
To filter returned changelogs by a given entityId, include a query string with entityId={entityId} parameter in the request.
The following table shows the possible response codes for this operation:
| Response Code | Name | Description |
|---|---|---|
| 200 | OK | The request completed. |
| 401 | Unauthorized | The system received a request from a user that is not authenticated. |
| 403 | Forbidden | The system received a request that the user is not authorized to make. |
| 500 | Internal Server Error | An unexpected condition was encountered. |
| 503 | Service Unavailable | The system is experiencing heavy load or another system failure. |
The following table shows the URI parameters for the request:
| Name | Type | Description |
|---|---|---|
| {entityId} | String (Required) | The ID for the monitoring zone. Use the List entities operation to find the entityId if you don’t know it. |
Note
This operation does not accept a request body.
This operation does not return a response body.