Oracle Management Cloud Common REST API

Get details of the alert

get

/serviceapi/eventServices/alerts/{alertId}

Retrieves the details of the alert identified by id.

Request

Supported Media Types

application/json

Path Parameters

alertId: string

The id of the alert

Response

Supported Media Types

application/json

200 Response

query was successful

Root Schema : AlertDetails

Type: object

The alert details has various properties about an alert managed in Oracle Management Cloud. An alert represents a series of events that occur over time. An alert is uniquely identified by its id. The alert is initially created when an event with a non CLEAR severity is first detected over some aspect of the associated entity. The alert's severity changes over time based on newer events. The alert is finally cleared based on an event with CLEAR severity.

Show Source

alertId: string

The id of the alert

Example: 62965132339213727047162539738389170623
canonicalLink(optional): string

The link to get this alert summary

Example: /serviceapi/eventServices/alerts/62965132339213727047162539738389170623
clearLink(optional): string

The link to clear this alert. It is populated when isAutoClose property is false for the alert

Example: /serviceapi/eventServices/alerts/62965132339213727047162539738389170623
creationTime: string

The creation time (in UTC) of this alert

Example: 2020-09-02T19:41:53.281Z
entityId(optional): string

The id of the associated entity

Example: FCF117D21649E34D141B0A160F28C494
entityName(optional): string

The display name of the associated entity

Example: myhost.mydomain.com
entityType(optional): string

The entity type of the associated entity

Example: omc_host_linux
entityTypeDisplayName(optional): string

The entity type display name of the associated entity

Example: Host (Linux)
eventName(optional): string

The name of the event associated with this alert

Example: HOST_Memory:logicalMemoryUtilizationPercent
eventType: string

The event type of the alert

Example: omc_metric_alert
eventTypeDisplayName(optional): string

The display name of the event type for the alert

Example: Fixed Threshold
firstEventTime: string

The time (in UTC) of the first event associated with this alert

Example: 2020-09-02T19:41:47.000Z
hasTicket(optional): boolean

True if the alert is associated with a ticket

Example: true
imported(optional): boolean

False if the alert was detected by Oracle Management Cloud. True if was uploaded from an external system, such as Oracle Enterprise Manager.

Example: false
isAutoClose: boolean

True if the system can detect and update clearing of the alert

Example: true
lastUpdatedTime: string

The last time (in UTC) this alert was updated

Example: 2020-09-02T19:51:56.032Z
latestEventTime: string

The time (in UTC) of the latest event associated with this alert

Example: 2020-09-02T19:41:47.000Z
message: string

The alert message

Example: Logical Memory Utilization for myhost.mydomain.com is 92.78 %; it is greater than expected value of 80 % for 10 minutes
open(optional): boolean

True if the alert's is still open. False if the alert's severity is CLEAR

Example: /serviceapi/eventServices/alerts/62965132339213727047162539738389170623
severity: string

Allowed Values: [ "FATAL", "CRITICAL", "WARNING", "CLEAR" ]

The severity of the alert

Example: CRITICAL

{
    "type":"object",
    "required":[
        "alertId",
        "message",
        "severity",
        "eventType",
        "isAutoClose",
        "creationTime",
        "lastUpdatedTime",
        "firstEventTime",
        "latestEventTime"
    ],
    "properties":{
        "alertId":{
            "type":"string",
            "description":"The id of the alert",
            "example":"62965132339213727047162539738389170623"
        },
        "message":{
            "type":"string",
            "description":"The alert message",
            "example":"Logical Memory Utilization for myhost.mydomain.com is 92.78 %; it is greater than expected value of 80 % for 10 minutes"
        },
        "entityId":{
            "type":"string",
            "description":"The id of the associated entity",
            "example":"FCF117D21649E34D141B0A160F28C494"
        },
        "entityName":{
            "type":"string",
            "description":"The display name of the associated entity",
            "example":"myhost.mydomain.com"
        },
        "entityType":{
            "type":"string",
            "description":"The entity type of the associated entity",
            "example":"omc_host_linux"
        },
        "entityTypeDisplayName":{
            "type":"string",
            "description":"The entity type display name of the associated entity",
            "example":"Host (Linux)"
        },
        "eventType":{
            "type":"string",
            "description":"The event type of the alert",
            "example":"omc_metric_alert"
        },
        "eventTypeDisplayName":{
            "type":"string",
            "description":"The display name of the event type for the alert",
            "example":"Fixed Threshold"
        },
        "isAutoClose":{
            "type":"boolean",
            "description":"True if the system can detect and update clearing of the alert",
            "example":"true"
        },
        "eventName":{
            "type":"string",
            "description":"The name of the event associated with this alert",
            "example":"HOST_Memory:logicalMemoryUtilizationPercent"
        },
        "imported":{
            "type":"boolean",
            "description":"False if the alert was detected by Oracle Management Cloud. True if was uploaded from an external system, such as Oracle Enterprise Manager.",
            "example":"false"
        },
        "hasTicket":{
            "type":"boolean",
            "description":"True if the alert is associated with a ticket",
            "example":"true"
        },
        "severity":{
            "type":"string",
            "enum":[
                "FATAL",
                "CRITICAL",
                "WARNING",
                "CLEAR"
            ],
            "description":"The severity of the alert",
            "example":"CRITICAL"
        },
        "open":{
            "type":"boolean",
            "description":"True if the alert's is still open. False if the alert's severity is CLEAR",
            "example":"/serviceapi/eventServices/alerts/62965132339213727047162539738389170623"
        },
        "creationTime":{
            "type":"string",
            "description":"The creation time (in UTC) of this alert",
            "example":"2020-09-02T19:41:53.281Z"
        },
        "lastUpdatedTime":{
            "type":"string",
            "description":"The last time (in UTC) this alert was updated",
            "example":"2020-09-02T19:51:56.032Z"
        },
        "firstEventTime":{
            "type":"string",
            "description":"The time (in UTC) of the first event associated with this alert",
            "example":"2020-09-02T19:41:47.000Z"
        },
        "latestEventTime":{
            "type":"string",
            "description":"The time (in UTC) of the latest event associated with this alert",
            "example":"2020-09-02T19:41:47.000Z"
        },
        "canonicalLink":{
            "type":"string",
            "description":"The link to get this alert summary",
            "example":"/serviceapi/eventServices/alerts/62965132339213727047162539738389170623"
        },
        "clearLink":{
            "type":"string",
            "description":"The link to clear this alert. It is populated when isAutoClose property is false for the alert",
            "example":"/serviceapi/eventServices/alerts/62965132339213727047162539738389170623"
        }
    },
    "description":"<p>\n The alert details has various properties about an alert managed in Oracle Management Cloud.\n    An alert represents a series of events that occur over time. An alert is uniquely identified by its id. The alert is initially created when an event with a non CLEAR severity is first detected over some aspect of the associated entity. The alert's severity changes over time based on newer events. The alert is finally cleared based on an event with CLEAR severity.\n</p>"
}

400 Response

The alert id is invalid

Root Schema : InvalidRequest

Type: object

When invalid alert API request is received, alert system returns this response.

Show Source

errorCode: string

The alert system's internal error code
errorMessage: string

The alert system's internal error message
httpMessage: string

The http error message
httpStatusCode: string

Default Value: 400

The http status code

{
    "type":"object",
    "required":[
        "httpStatusCode",
        "httpMessage",
        "errorCode",
        "errorMessage"
    ],
    "properties":{
        "httpStatusCode":{
            "type":"string",
            "description":"The http status code",
            "default":"400"
        },
        "httpMessage":{
            "type":"string",
            "description":"The http error message"
        },
        "errorCode":{
            "type":"string",
            "description":"The alert system's internal error code"
        },
        "errorMessage":{
            "type":"string",
            "description":"The alert system's internal error message"
        }
    },
    "description":"<p>\n When invalid alert API request is received, alert system returns this response.\n</p>"
}

500 Response

encountered unhandled exception

Root Schema : UnhandledException

Type: object

When alert system runs into unhandled exception, it returns this response.

Show Source

errorCode: string

Default Value: general_error

The alert system's error code for unhandled exception
errorMessage: string

Default Value: Internal Server Error

The alert system's error message for unhandled exception
httpMessage: string

Default Value: Internal Server Error

The http error message
httpStatusCode: string

Default Value: 500

The http status code

{
    "type":"object",
    "required":[
        "httpStatusCode",
        "httpMessage",
        "errorCode",
        "errorMessage"
    ],
    "properties":{
        "httpStatusCode":{
            "type":"string",
            "description":"The http status code",
            "default":"500"
        },
        "httpMessage":{
            "type":"string",
            "description":"The http error message",
            "default":"Internal Server Error"
        },
        "errorCode":{
            "type":"string",
            "description":"The alert system's error code for unhandled exception",
            "default":"general_error"
        },
        "errorMessage":{
            "type":"string",
            "description":"The alert system's error message for unhandled exception",
            "default":"Internal Server Error"
        }
    },
    "description":"<p>\n When alert system runs into unhandled exception, it returns this response.\n</p>"
}

Examples

Get details of the alert

curl -u ${OMC_USERNAME}:${PASSWORD} -X GET "https://serverurl/serviceapi/eventServices/alerts/62965132339213727047162539738389170623"

The response might look like the following:

       {
          "alertId": "62965132339213727047162539738389170623",
          "entityId": "87B65F77DE4F200AE5374A2D38B5E31F",
          "entityName": "myhost.mydomain.com",
          "entityDisplayName": "my host",
          "entityType": "omc_host_linux",
          "entityTypeDisplayName": "Host (Linux)",
          "eventType": "omc_metric_alert",
          "eventTypeDisplayName": "Fixed Threshold",
          "message": "Logical Memory Utilization for myhost.mydomain.com is 92.78 %; it is greater than expected value of 80 % for 10 minutes",
          "severity": "WARNING",
          "canonicalLink": "serviceapi/eventServices/alerts/62965132339213727047162539738389170623",
          "serviceType": "Monitoring",
          "open": true,
          "isAutoClose": true,
          "eventName": "HOST_Memory:logicalMemoryUtilizationPercent",
          "imported": false,
          "hasTicket": false,
          "creationTime": "2020-09-01T08:40:02.946Z",
          "lastUpdatedTime": "2020-09-09T17:13:08.463Z",
          "firstEventTime": "2020-09-01T08:38:55.472Z",
          "latestEventTime": "2020-09-01T08:38:55.472Z"
       }