- API >
- Public API Resources >
- Measurements and Alerts >
- Global Alerts >
- Get One Global Alert
Get One Global Alert¶
On this page
Retrieve one alert identified with its ALERT-ID
.
Required Roles¶
You can successfully call this endpoint with any of the following assigned roles:
Request¶
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Request Path Parameters¶
Name | Type | Description |
---|---|---|
ALERT-ID |
string | Unique identifier of the alert you want to retrieve. |
Request Query Parameters¶
Name | Type | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|
pretty |
boolean | Flag indicating whether the response body should be in a prettyprint format. | false |
||||||
envelope |
boolean | Flag indicating whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set For endpoints that return one result, the response body includes:
|
false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Name | Type | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
acknowledgedUntil |
string | Timestamp in ISO 8601 date and time format in UTC through which the alert has been acknowledged. Ops Manager presents this field if a user acknowledged this alert. | ||||||||
acknowledgementComment |
string | Comment that the user who acknowledged this alert left. Ops Manager presents this field if a user acknowledged this alert. | ||||||||
acknowledgingUsername |
string | Ops Manager username of the user who acknowledged the alert. Ops Manager presents this field if a user acknowledged this alert. | ||||||||
alertConfigId |
string | Unique identifier of the global alert configuration that triggered this alert. | ||||||||
clusterId |
string | Unique identifier of the cluster to which this alert applies. Ops Manager returns this field for global alerts in the categories of: |
||||||||
clusterName |
string | Name the cluster to which this alert applies. Ops Manager returns this field for global alerts in the categories of: |
||||||||
created |
string | Timestamp in ISO 8601 date and time format in UTC when the alert was created. | ||||||||
currentValue |
object | Current value of the metric that triggered the alert. Ops Manager returns this field for global alerts in the category of host. | ||||||||
currentValue.number |
number | Current value of the metric. | ||||||||
currentValue.units |
string | Units in which this value is expressed. Depends on the type of metric. Example
Possible values that can be returned include:
|
||||||||
eventTypeName |
string | Name of the event that triggered the alert. To review the types of events that generate alerts, see Alert Types. For a complete list of events included in the Ops Manager audit log, see Audit Events. |
||||||||
groupId |
string | Unique identifier of the project for which this alert was opened. | ||||||||
hostId |
string | Unique identifier of the host to which the metric pertains. Ops Manager returns this field for global alerts in the categories of: |
||||||||
hostnameAndPort |
string | Hostname and port of each host to which the alert applies. The hostname can be only a hostname, an FQDN, an IPv4 address, or an IPv6 address. Ops Manager returns this field for global alerts in the categories of: |
||||||||
id |
string | Unique identifier of the alert. | ||||||||
lastNotified |
string | Timestamp in ISO 8601 date and time format in UTC when the last notification was sent for this alert. Ops Manager displays this if Ops Manager sent notifications. | ||||||||
metricName |
string | Name of the measurement whose value went outside the threshold.
Ops Manager returns this field if For possible values, see Measurement Types for Global Alerts. |
||||||||
replicaSetName |
string | Name of the replica set. Ops Manager returns this field for global alerts in the categories of: |
||||||||
resolved |
string | Timestamp in ISO 8601 date and time format in UTC when the alert was closed. Ops Manager returns this field for global
alerts when "status" : "CLOSED" . |
||||||||
sourceTypeName |
string | Type of host being backed up. Ops Manager returns this field for global alerts in the category of backup. Possible values that can be returned include:
|
||||||||
status |
string | Current state of the alert. Possible values that can be returned include:
|
||||||||
tags |
array of strings | Tags associated with this alert. | ||||||||
typeName |
string | This field is deprecated and will be ignored. | ||||||||
updated |
string | Timestamp in ISO 8601 date and time format in UTC when this alert was last updated. |