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

すべてのアラートの取得

項目一覧

  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • 応答ドキュメント
  • results embeddedDocument
  • アラートの測定タイプ
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

注意

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

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

Resource

GET /groups/{PROJECT-ID}/alerts

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

Parameter
タイプ
説明
プロジェクトID
string
（必須。） プロジェクト識別子。

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

名前
タイプ
必要性
説明
default
pageNum
数値
任意
結果のサブセクションを返す 1 から始まる整数。
1
itemsPerPage
数値
任意
1 ページあたりに返す項目の数は最大 500 です。
100
pretty
ブール値
任意
false
envelope
ブール値
任意

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

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

結果のリストを返すエンドポイントの場合、 contentオブジェクトはエンベロープです。 Cloud Manager は、レスポンス本体にstatusフィールドを追加します。

false
backupJobsEnabledOnly
ブール値
任意
データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これをfalseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。
true
名前
タイプ
必要性
説明
status
string
任意

ステータスを指定して、指定したステータスのアラートのみを返します。 省略すると、すべてのアラートが返されます。

Cloud Manager は、次の値を受け入れます。

  • TRACKING

    TRACKINGステータスのアラートを返すには、 アラートの設定で通知遅延が指定されている場合、Cloud Manager は遅延期間が終了するまでそのアラートにTRACKINGステータスを割り当てます。 遅延が発生した後も条件が維持される場合、Cloud Manager はステータスをOPENに設定します。

    アラートの構成に複数の通知があり、それぞれの通知遅延は異なる場合、Cloud Manager は最小の遅延値を使用して、アラートをTRACKINGからOPENに移動するタイミングを決定します。

  • OPEN
    すべてのオープン アラートを返します。
  • CLOSED
    すべての閉じたアラートを返します。

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

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前
タイプ
説明
results
配列
配列には、 results埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
links
配列
配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。
totalCount
数値
結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

results embeddedDocument

各結果は 1 つのアラートです。

名前
タイプ
説明
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 の日時形式。

アラートの測定タイプ

alertsリソースは、 metricNameフィールドに測定型を返します。 このフィールドは、 eventTypeNameがOUTSIDE_METRIC_THRESHOLDに設定されている場合にのみ存在します。

ホスト測定値

  • ASSERT_REGULAR

  • ASSERT_WARNING

  • ASSERT_MSG

  • ASSERT_USER

serverStatusコマンドが生成するassertsドキュメントにある MongoDB プロセスのアサートのレート。

  • BACKGROUND_FLUSH_AVG

バックグラウンドでフラッシュされるデータの量。

  • CACHE_BYTES_READ_INTO

  • CACHE_BYTES_WRITTEN_FROM

  • CACHE_DIRTY_BYTES

  • CACHE_USED_BYTES

  • TICKETS_AVAILABLE_READS

  • TICKETS_AVAILABLE_WRITE

serverStatus コマンドが生成する ドキュメントと ドキュメントにある WiredTiger ストレージ エンジンwiredTiger.cache wiredTiger.concurrentTransactionsキャッシュ内のバイト数。

  • CONNECTIONS

serverStatusコマンドが生成するconnectionsドキュメントにある MongoDB プロセスへの接続の数。

  • CURSORS_TOTAL_OPEN

  • CURSORS_TOTAL_TIMED_OUT

serverStatus コマンドが生成する ドキュメントにある MongoDB プロセスの カーソルmetrics.cursor の数。

  • EXTRA_INFO_PAGE_FAULTS

  • GLOBAL_ACCESSES_NOT_IN_MEMORY

  • GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN

MongoDB プロセスのMemory IssuesとPage Faultsの数。

  • GLOBAL_LOCK_CURRENT_QUEUE_TOTAL

  • GLOBAL_LOCK_CURRENT_QUEUE_READERS

  • GLOBAL_LOCK_CURRENT_QUEUE_WRITERS

serverStatusコマンドが生成する MongoDB プロセスのロックを待機している操作の数。 Cloud Manager は、ストレージ エンジンのタイプに基づいてこれらの値を計算します。

  • INDEX_COUNTERS_BTREE_ACCESSES

  • INDEX_COUNTERS_BTREE_HITS

  • INDEX_COUNTERS_BTREE_MISSES

  • INDEX_COUNTERS_BTREE_MISS_RATIO

インデックス b木操作の数。

  • JOURNALING_COMMITS_IN_WRITE_LOCK

  • JOURNALING_MB

  • JOURNALING_WRITE_DATA_FILES_MB

ジャーナリング操作 の数。

  • MEMORY_RESIDENT

  • MEMORY_VIRTUAL

  • MEMORY_MAPPED

  • COMPUTED_MEMORY

serverStatusコマンドが収集するmemドキュメントにある MongoDB プロセスのメモリの量。

  • NETWORK_BYTES_IN

  • NETWORK_BYTES_OUT

  • NETWORK_NUM_REQUESTS

serverStatusコマンドが収集するnetworkドキュメントにある MongoDB プロセスのスループットの量。

  • OPLOG_RATE_GB_PER_HOUR

  • OPLOG_MASTER_TIME

  • OPLOG_MASTER_LAG_TIME_DIFF

  • OPLOG_SLAVE_LAG_MASTER_TIME

  • DB_STORAGE_TOTAL

  • DB_DATA_SIZE_TOTAL

MongoDB dbStatsコマンドから収集された、ディスク上のストレージ容量。

  • OPCOUNTER_CMD

  • OPCOUNTER_QUERY

  • OPCOUNTER_UPDATE

  • OPCOUNTER_DELETE

  • OPCOUNTER_GETMORE

  • OPCOUNTER_INSERT

serverStatusコマンドが収集するopcountersドキュメントで、プロセスが最後に開始されてからの MongoDB プロセスでのデータベース操作の速度。

  • OPCOUNTER_REPL_CMD

  • OPCOUNTER_REPL_UPDATE

  • OPCOUNTER_REPL_DELETE

  • OPCOUNTER_REPL_INSERT

serverStatus コマンドが収集する ドキュメントにある、MongoDB セカンダリ opcountersReplでのデータベース操作の速度。

  • DOCUMENT_METRICS_RETURNED

  • DOCUMENT_METRICS_INSERTED

  • DOCUMENT_METRICS_UPDATED

  • DOCUMENT_METRICS_DELETED

選択した期間中に、1 秒あたりに返される、挿入、更新、または削除されるドキュメントの平均レート。

  • OPERATIONS_SCAN_AND_ORDER

ソートを実行するが、インデックスを使用してソートを実行できない、選択した期間における 1 秒あたりの操作の平均レート。

  • OP_EXECUTION_TIME_READS

  • OP_EXECUTION_TIME_WRITES

  • OP_EXECUTION_TIME_COMMANDS

選択した期間中の読み取り、書込み、またはコマンド操作あたりの平均実行時間（ミリ秒）。

MongoDB 3.4 以降を実行しているホストで使用できます。

  • RESTARTS_IN_LAST_HOUR

過去 1 時間以内にホストが再起動した回数。

  • SYSTEM_MEMORY_USED

  • SYSTEM_MEMORY_FREE

  • SYSTEM_MEMORY_AVAILABLE

物理メモリ使用量（バイト単位）。

  • SYSTEM_NETWORK_BYTES_IN

  • SYSTEM_NETWORK_BYTES_OUT

ネットワーク スループット（1 秒あたりのバイト数単位）。

  • SWAP_USAGE_USED

  • SWAP_USAGE_FREE

使用中のスワップ領域の合計量。

  • QUERY_EXECUTOR_SCANNED

explainコマンドのtotalKeysExaminedの値に表示される、クエリおよびクエリプランの評価中にインデックス項目をスキャンするための 1 秒あたりの平均レート。

  • QUERY_EXECUTOR_SCANNED_OBJECTS

クエリおよびクエリプランの評価中に 1 秒あたりにスキャンされるドキュメントの平均レートは、 explainコマンドのtotalDocsExaminedの値にあります。

  • QUERY_TARGETING_SCANNED_PER_RETURNED

返されたドキュメント数に対するスキャンされたインデックス数の比率。

  • QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED

返されたドキュメント数に対するスキャンされたドキュメント数の比率。

リクエストの例

次の例では、すべてのOPENアラートが返されます。

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts?status=OPEN&pretty=true"

応答例

応答ヘッダー

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  "links" : [ {
3    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts?status=OPEN&pretty=true&pageNum=1&itemsPerPage=100",
4    "rel" : "self"
5  } ],
6  "results" : [ {
7    "alertConfigId" : "5953c5f380eef53887615fd4",
8    "created" : "2019-07-18T23:43:50Z",
9    "eventTypeName" : "MONITORING_AGENT_DOWN",
10    "groupId" : "{PROJECT-ID}",
11    "id" : "5d31043680eef5280d3664e0",
12    "lastNotified" : "2019-09-25T11:50:08Z",
13    "links" : [ {
14      "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts/5d31043680eef5280d3664e0",
15      "rel" : "self"
16    } ],
17    "status" : "OPEN",
18    "tags" : [ ],
19    "typeName" : "AGENT",
20    "updated" : "2019-07-18T23:43:50Z"
21  } ],
22  "totalCount" : 1
23}

戻る

アラート

次へ

アラートを 1 つ取得