GET /resource_status

Fetches the resources' statuses that contain the alerts with the highest severity found for the resources. Resource with ID that was not found in resourceId parameter of any active alert considered to have the "ok" severity.

This endpoint may return multiple records for the same resource if it has multiple alerts with the same severity and the same creation time.

Request

  • Base URL
    https://dev-cloud.acronis.com/api/alert_manager/v1
  • Auth
    OAuth 2
    Authorization code: https://dev-cloud.acronis.com/api/2/idp/authorize
    Client credentials
    Password
    Token URL: https://dev-cloud.acronis.com/api/2/idp/token scopes: urn:acronis.com::alert_manager::viewer

Query parameters

idstring[]

IDs of the resources; if omitted, the response will contain statuses for all resources that have alerts.

For resources with multiple IDs, the client must specify resource's IDs by using the or() operator:

  • Example: id=or(ID3,ID4,ID5) - looks for status of a single resource

  • Example: id=ID1&id=or(ID3,ID4,ID5)&id=or(ID6,ID7)&id=ID8 - looks for status of four resources

embed_alertboolean

If true, the entire alert object will be included in the response.

Response

List of alert grouping by resource IDs.

Example response

{
  "items": [
    {
      "id": "0A0E639A-4E27-4C61-AFFF-7BE314C30A33",
      "severity": "critical",
      "alert": {
        "id": "01C2D69A-112B-4DE1-98AE-8688223C5F4B",
        "type": "BackupFailed",
        "createdAt": "2021-04-02T22:16:16Z",
        "severity": "critical",
        "receivedAt": "2021-04-01T22:16:19.71025511Z",
        "updatedAt": "2021-04-02T22:16:16.426961168Z",
        "tenant": {
          "id": "56",
          "locator": "/1/10/20/30/"
        },
        "details": {
          "activity": {
            "id": "9C3DE32F-DCB3-4106-9988-56BFF5A64D98",
            "type": "8F01AC13-F59E-4851-9204-DE1FD77E36B4"
          }
        },
        "category": "Backup"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.