- API >
- Public API Resources >
- Measurements and Alerts >
- Alert Configurations >
- Get Open Alerts for Alert Configuration
Get Open Alerts for Alert Configuration¶
On this page
Note
Groups and projects are synonymous terms. Your {GROUP-ID}
is the
same as your project id. For existing groups, your group/project id
remains the same. This page uses the more familiar term group when
referring to descriptions. The endpoint remains as stated in the
document.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Request Path Parameters¶
Parameter | Type | Description |
---|---|---|
GROUP-ID | string | (Required.) Group identifier. |
ALERT-CONFIG-ID | string | (Required.) Alert configuiration identifier. |
Request Query Parameters¶
This endpoint may use any of the HTTP request query parameters available to all Ops Manager API resources. These are all optional.
Name | Type | Description | Default |
---|---|---|---|
pageNum | integer | Page number (1-based). | 1 |
itemsPerPage | integer | Maximum number of items to return, up to a maximum of 100. | 100 |
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 a list of results, the |
false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Response Document¶
The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.
Name | Type | Description |
---|---|---|
results | object array | This array includes one object for each item detailed in the results Embedded Document section. |
links | object array | This array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. |
totalCount | number | The count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated. |
results Embedded Document¶
Each result is one alert configuration.
Note
Alert details vary. An alert may only include a subset of these elements.
Name | Type | Description |
---|---|---|
id | string | Unique identifier for the alert. |
groupId | string | Unique identifier of the group that this alert was opened for. |
alertConfigId | string | Unique identifier of the alert configuration that triggered this alert. |
eventTypeName | string | The name of the event that triggered the alert.
|
typeName | string | This field is deprecated and will be ignored. |
status | string | The current state of the alert. Possible values are:
|
acknowledgedUntil | date | The date through which the alert has been acknowledged. Will not be present if the alert has never been acknowledged. |
acknowledgementComment | string | The comment left by the user who acknowledged the alert. Will not be present if the alert has never been acknowledged. |
acknowledgingUsername | string | The username of the user who acknowledged the alert. Will not be present if the alert has never been acknowledged. |
created | date | When the alert was opened. |
updated | date | When the alert was last updated. |
resolved | date | When the alert was closed. Only present if the status is CLOSED . |
lastNotified | date | When the last notification was sent for this alert. Only present if notifications have been sent. |
hostnameAndPort | string | The hostname and port of each host to which the alert applies. Only
present for alerts of type HOST , HOST_METRIC , and
REPLICA_SET . |
hostId | string | Unique identifier of the host to which the metric pertains. Only present for
alerts of type HOST , HOST_METRIC , and REPLICA_SET . |
replicaSetName | string | Name of the replica set. Only present for alerts of type HOST ,
HOST_METRIC , BACKUP , and REPLICA_SET . |
metricName | string | The name of the measurement whose value went outside the threshold. Only
present if For possible values, see Measurement Types for Alerts on this page. |
currentValue | object | The current value of the metric that triggered the alert. Only present for
alerts of type HOST_METRIC . |
currentValue.number | number | The value of the metric. |
currentValue.units | string | The units for the value. Depends on the type of metric. For example, a metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit. Possible values are:
|
clusterId | string | The Unique identifier of the cluster to which this alert applies. Only present for
alerts of type BACKUP , REPLICA_SET , and CLUSTER . |
clusterName | string | The name the cluster to which this alert applies. Only present for
alerts of type BACKUP , REPLICA_SET , and CLUSTER . |
sourceTypeName | string | For alerts of the type
|