For AI agents: a documentation index is available at https://www.mongodb.com/ko-kr/docs/llms.txt — markdown versions of all pages are available by appending .md to any URL path.

Acknowledge One Alert

Note

Groups and projects are synonymous terms. Your {PROJECT-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.

Resource

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

PATCH /groups/{PROJECT-ID}/alerts/{ALERT-ID}

Request Path Parameters

Parameter
Type
Necessity
Description

PROJECT-ID

string

Required

Unique identifier for the Project in which this alert is set.

ALERT-ID

string

Required

Unique identifier for the Alert.

Request Query Parameters

The following query parameters are optional:

Name
Type
Necessity
Description
Default

pretty

boolean

Optional

Flag indicating whether the response body is in a prettyprint format.

false

envelope

boolean

Optional

Flag that indicates whether to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

  • status: HTTP response code

  • content: Expected response body

false

Request Body Parameters

Field
Type
Necessity
Description

acknowledged
Until

string

Conditional

Timestamp in ISO 8601 date and time format in UTC until which the alert should be acknowledged.

  • To acknowledge an alert "forever", set the field value to a large number of years in the future. Recommend setting to 100 years in the future.

  • To unacknowledge an acknowledged alert, remove this parameter from your request.

acknowledgement
Comment

string

Optional

Text description of the reason for this acknowledgement.

Ops Manager displays the comment next to the message that the alert has been acknowledged.

Response

The fields in the return document depend on the alert type:

Name
Type
Description

acknowledged
Until

string

Timestamp in ISO 8601 date and time format in UTC until which the alert has been acknowledged.

Ops Manager returns this value if the alert has been acknowledged.

acknowledgement
Comment

string

Comment left by the user who acknowledged the alert.

Ops Manager returns this value if the alert has been acknowledged.

acknowledging
Username

string

Username of the user who acknowledged the alert.

Ops Manager returns this value if the alert has been acknowledged.

alertConfigId

string

Unique identifier for the alert configuration that triggered this alert.

clusterId

string

Unique identifier for the cluster to which this alert applies.

Ops Manager returns this value if "eventTypeName" : "SHARDED_CLUSTER"

clusterName

string

Name of the cluster to which this alert applies.

Ops Manager returns this value if "eventTypeName" : "SHARDED_CLUSTER"

created

string

Timestamp in ISO 8601 date and time format in UTC when the alert was opened.

currentValue

object

Current value of the metric that triggered the alert.

Ops Manager returns this value if "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD".

currentValue
.number

number

Value of the metric.

currentValue
.units

string

Units for the value. 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.

Ops Manager can return:

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

eventTypeName

string

Name of the event that triggered the alert.

Accepted values are:

Agent

Automation Configuration

Backup

BI Connector

Cluster

Data Explorer Accessed

Host

Organization

Project

Replica Set

Team

User

For a complete list of events included in the Ops Manager audit log, see Audit Events.

groupId

string

Unique identifier of the group for which this alert was opened.

hostId

string

unique identifier for the host to which the metric pertains.

Ops Manager returns this value if "eventTypeName" was set to one of the following:

  • HOST_DOWN

  • OUTSIDE_METRIC_THRESHOLD

  • REPLICA_SET

hostnameAndPort

string

Hostname and port of each host to which the alert applies. This can be a hostname, an FQDN, an IPv4 address, or an IPv6 address.

Ops Manager returns this value if "eventTypeName" was set to one of the following:

  • HOST_DOWN

  • OUTSIDE_METRIC_THRESHOLD

  • REPLICA_SET

id

string

Unique identifier for 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 returns this value if notifications have been sent.

links

array of objects

One or more links to sub-resources or related resources. All links arrays in responses include at least one link called self. The relationships between URLs are explained in the Web Linking Specification.

metricName

string

Name of the measurement whose value went outside the threshold.

Ops Manager returns this value if "eventTypeName" was set to OUTSIDE_METRIC_THRESHOLD.

For possible values, see Measurement Types for Alerts.

replicaSetName

string

Name of the replica set.

Ops Manager returns this value if "eventTypeName" was set to one of the following:

  • BACKUP

  • HOST_DOWN

  • OUTSIDE_METRIC_THRESHOLD

  • REPLICA_SET

resolved

string

Timestamp in ISO 8601 date and time format in UTC when the alert was closed.

Ops Manager returns this value if "status" : "CLOSED".

status

string

Current state of the alert. Ops Manager can return one of the following:

  • TRACKING

    The alert condition exists but has not persisted beyond the defined notification delay. For details, see Request Query Parameters.

  • OPEN

  • CLOSED

  • CANCELLED

sourceTypeName

string

Type of host being backed up when "eventTypeName" : "BACKUP". Ops Manager can return one of the following:

  • REPLICA_SET

  • SHARDED_CLUSTER

  • CONFIG_SERVER

tags

string array

Identifying labels set for this alert.

updated

string

Timestamp in ISO 8601 date and time format in UTC when the alert was last updated.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \     --header "Accept: application/json" \     --header "Content-Type: application/json" \     --include \     --request PATCH "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-CONFIG-ID}"     --data '       {         "acknowledgedUntil": "2016-04-15T00:00:00-0400",         "acknowledgementComment": "This is normal. Please ignore."       }'

Example Response

Response Header

HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

{  "id" : "{ALERT-CONFIG-ID}",  "groupId" : "{PROJECT-ID}",  "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",  "status" : "OPEN",  "acknowledgedUntil" : "2014-04-15T04:00:00Z",  "acknowledgementComment" : "This is normal. Please ignore.",  "acknowledgingUsername" : "someuser@example.com",  "created" : "2014-04-03T20:28:14Z",  "updated" : "2014-04-03T20:33:14Z",  "lastNotified" : "2014-04-03T20:33:23Z",  "metricName": "ASSERTS_REGULAR",  "currentValue" : {    "number" : 0.0,    "units" : "RAW"  },  "links" : []}
Back
Get One
Next
Alert Configurations
Rate this page

On this page