Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
リソース
/
測定値とアラート
/
アラート

アラートを 1 つ確認

項目一覧

  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

注意

グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。

Resource

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

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

リクエスト パス パラメーター

Parameter
タイプ
必要性
説明
PROJECT-ID
string
必須
このアラートが設定されているプロジェクトの一意の識別子。
ALERT-ID
string
必須
アラートの一意の識別子です。

リクエスト クエリ パラメータ

次のクエリ パラメータは 任意です。

名前
タイプ
必要性
説明
default
pretty
ブール値
任意
false
envelope
ブール値
任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前
説明
status
HTTPレスポンス コード
content
期待される応答本体
false

リクエスト ボディ パラメータ

フィールド
タイプ
必要性
説明
acknowledged
Until
string
条件付き

ISO8601 のタイムスタンプ アラートが確認されるまで、 UTC の日付と時刻形式。

  • アラートを「永久」に確認するには、 フィールドの値を数年後に設定します。 を 100 年後に設定することをお勧めします。

  • 確認済みのアラートを未確認にするには、リクエストからこのパラメータを削除します。

acknowledgement
Comment
string
任意

この確認応答の理由のテキスト説明。

Cloud Manager は、アラートが確認されたことを示すメッセージの横にコメントを表示します。

応答

返されるドキュメント内のフィールドは、 アラートの種類 によって異なります。

名前
タイプ
説明
acknowledged
Until
string

ISO8601 のタイムスタンプ アラートが確認されたまでの日付と時刻形式（ UTC） 。

アラートが確認された場合、Cloud Manager はこの値を返します。

acknowledgement
Comment
string

アラートを確認したユーザーが残すコメント。

アラートが確認された場合、Cloud Manager はこの値を返します。

acknowledging
Username
string

アラートを確認したユーザーのユーザー名。

アラートが確認された場合、Cloud Manager はこの値を返します。

alertConfigId
string
このアラートをトリガーしたアラート構成の一意の識別子。
clusterId
string

このアラートが適用されるクラスターの一意の識別子。

Cloud Manager は次の場合にこの値を返します。 "eventTypeName" : "SHARDED_CLUSTER"

clusterName
string

このアラートが適用されるクラスターの名前。

Cloud Manager は次の場合にこの値を返します。 "eventTypeName" : "SHARDED_CLUSTER"

created
string
ISO8601 のタイムスタンプ アラートが開かれたときの UTC の日付と時刻形式。
currentValue
オブジェクト

アラートをトリガーしたメトリクスの現在の値。

Cloud Manager は、 "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"の場合にこの値を返します。

currentValue
.number
数値
メトリクスの値。
currentValue
.units
string

値の単位。 値は、メトリクスの型によって異なります。

たとえば、メモリ消費を測定するメトリクスにはバイト単位が含まれ、時間を測定するメトリクスには時間単位が含まれます。

Cloud Manager は次の結果を返すことができます。

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

eventTypeName
string

アラートをトリガーしたイベントの名前。

指定できる値は次のとおりです。

エージェント

  • AUTOMATION_AGENT_DOWN

  • AUTOMATION_AGENT_UP

  • BACKUP_AGENT_CONF_CALL_FAILURE

  • BACKUP_AGENT_DOWN

  • BACKUP_AGENT_UP

  • BACKUP_AGENT_VERSION_BEHIND

  • BACKUP_AGENT_VERSION_CURRENT

  • MONITORING_AGENT_DOWN

  • MONITORING_AGENT_UP

  • MONITORING_AGENT_VERSION_BEHIND

  • MONITORING_AGENT_VERSION_CURRENT

  • NEW_AGENT

オートメーション構成

  • AUTOMATION_CONFIG_PUBLISHED_AUDIT

バックアップ

  • BAD_CLUSTERSHOTS

  • CLUSTER_BLACKLIST_UPDATED_AUDIT

  • CLUSTER_CHECKKPOINT_UPDATED_AUDIT

  • CLUSTER_CREDENTIAL_UPDATED_AUDIT

  • CLUSTER_SNAPSHOT_SCHEDULE_UPDATED_AUDIT

  • CLUSTER_STATE_CHANGED_AUDIT

  • CLUSTER_STORAGE_ENGINE_UPDATED_AUDIT

  • CLUSTERSHOT_DELETED_AUDIT

  • CLUSTERSHOT_EXPIRY_UPDATED_AUDIT

  • CONSISTENT_BACKUP_CONFIGURATION

  • GOOD_CLUSTERSHOT

  • INCONSISTENT_BACKUP_CONFIGURATION

  • INITIAL_SYNC_FINISHED_AUDIT

  • INITIAL_SYNC_STARTED_AUDIT

  • OPLOG_BEHIND

  • OPLOG_CURRENT

  • RESTORE_REQUESTED_AUDIT

  • RESYNC_PERFORMED

  • RESYNC_REQUIRED

  • RS_BLACKLIST_UPDATED_AUDIT

  • RS_CREDENTIAL_UPDATED_AUDIT

  • RS_ROTATE_MASTER_KEY_AUDIT

  • RS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT

  • RS_STATE_CHANGED_AUDIT

  • RS_STORAGE_ENGINE_UPDATED_AUDIT

  • SNAPSHOT_DELETED_AUDIT

  • SNAPSHOT_EXPIRY_UPDATED_AUDIT

  • SYNC_PENDING_AUDIT

  • SYNC_REQUIRED_AUDIT

BI Connector

  • BI_CONNECTOR_DOWN

  • BI_CONNECTOR_UP

請求

クラスター

  • CLUSTER_MONGOS_IS_MISSING

  • CLUSTER_MONGOS_IS_PRESENT

  • SHARD_ADDED

  • SHARD_REMOVED

Data Explorer のアクセス

  • DATA_EXPLORER

  • DATA_EXPLORER_CRUD

ディスクバックアップ

Host

組織

プロジェクト

レプリカセット

サポートケース

チーム

  • TEAM_ADDED_TO_GROUP

  • TEAM_CREATED

  • TEAM_DELETED

  • TEAM_NAME_CHANGED

  • TEAM_REMOVED_FROM_GROUP

  • TEAM_ROLES_MODIFIED

  • TEAM_UPDATED

  • USER_ADDED_TO_TEAM

user

groupId
string
このアラートが開かれたグループの一意の識別子。
hostId
string

メトリクスが含まれるホストの一意の識別子。

"eventTypeName"が次のいずれかに設定されている場合、Cloud Manager はこの値を返します。

  • HOST_DOWN

  • OUTSIDE_METRIC_THRESHOLD

  • REPLICA_SET

hostnameAndPort
string

アラートが適用される各ホストのホスト名とポート。 これは、ホスト名、 FQDN 、 IPv4アドレス、またはIPv6アドレスにすることができます。

"eventTypeName"が次のいずれかに設定されている場合、Cloud Manager はこの値を返します。

  • HOST_DOWN

  • OUTSIDE_METRIC_THRESHOLD

  • REPLICA_SET

id
string
アラートの一意の識別子です。
lastNotified
string
ISO8601 のタイムスタンプ このアラートの最後の通知が送信された日時の UTC 形式の日付と時刻形式。通知が送信された場合、Cloud Manager はこの値を返します。
links
オブジェクトの配列

サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべてのlinks配列には、 selfと呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様 で説明されています。

metricName
string

値がしきい値を超えた測定値の名前。

"eventTypeName"がOUTSIDE_METRIC_THRESHOLDに設定されている場合、Cloud Manager はこの値を返します。

可能な値については、「アラートの測定タイプ 」を参照してください。

replicaSetName
string

レプリカセットの名前。

"eventTypeName"が次のいずれかに設定されている場合、Cloud Manager はこの値を返します。

  • BACKUP

  • HOST_DOWN

  • OUTSIDE_METRIC_THRESHOLD

  • REPLICA_SET

resolved
string

ISO8601 のタイムスタンプ アラートが閉じられたときの日付と時刻形式（ UTC） 。

Cloud Manager は、 "status" : "CLOSED"の場合にこの値を返します。

status
string

アラートの現在の状態。 Cloud Manager は、次のいずれかを返すことができます。

sourceTypeName
string

"eventTypeName" : "BACKUP"の場合にバックアップされるホストのタイプ。 Cloud Manager は、次のいずれかを返すことができます。

  • REPLICA_SET

  • SHARDED_CLUSTER

  • CONFIG_SERVER

tags
string 配列
このアラートに設定された識別ラベル。
typeName
string
非推奨の フィールド。 |mms|はそれを無視します。
updated
string
ISO8601 のタイムスタンプ アラートが最後に更新されたときの UTC の日時形式。

リクエストの例

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --include \
5     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-CONFIG-ID}"
6     --data '
7       {
8         "acknowledgedUntil": "2016-04-15T00:00:00-0400",
9         "acknowledgementComment": "This is normal. Please ignore."
10       }'

応答例

応答ヘッダー

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

レスポンス本体

1{
2  "id" : "{ALERT-CONFIG-ID}",
3  "groupId" : "{PROJECT-ID}",
4  "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
5  "status" : "OPEN",
6  "acknowledgedUntil" : "2014-04-15T04:00:00Z",
7  "acknowledgementComment" : "This is normal. Please ignore.",
8  "acknowledgingUsername" : "someuser@example.com",
9  "created" : "2014-04-03T20:28:14Z",
10  "updated" : "2014-04-03T20:33:14Z",
11  "lastNotified" : "2014-04-03T20:33:23Z",
12  "metricName": "ASSERTS_REGULAR",
13  "currentValue" : {
14    "number" : 0.0,
15    "units" : "RAW"
16  },
17  "links" : []
18}

戻る

アラートを 1 つ取得

次へ

Alert Configurations