AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
Docs Menu
Docs Home
/ /
アラート
Docs Home
/ /
測定値とアラート
/
アラート
Docs Home
/
管理
/
Cloud Manager
/
API
/
リソース
/
測定値とアラート
/
アラート

アラートを 1 つ取得

注意

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

ベース URL: https://cloud.mongodb.com/api/public/v1.0

Resource

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

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

Parameter
タイプ
説明

プロジェクトID

string

（必須。） プロジェクト識別子。

ALERT-ID

string

（必須。） アラート識別子。

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

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

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。

false

envelope

ブール値

任意

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

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

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

名前
説明

status

HTTPレスポンス コード

content

期待される応答本体

false

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

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

応答

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

名前
タイプ
説明

acknowledged
Until

string

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

アラートが確認された場合、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

アラートが開かれたときの ISO の日付と時刻形式（UTC）のタイムスタンプ。8601

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_DENYLIST_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_DENYLIST_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

アラートが最後に更新されたときの ISO の日付と時刻形式（UTC）のタイムスタンプ。8601

アラートの測定タイプ

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

ホスト測定値

  • ASSERT_REGULAR

  • ASSERT_WARNING

  • ASSERT_MSG

  • ASSERT_USER

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

  • BACKGROUND_FLUSH_AVG

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

  • CACHE_BYTES_READ_INTO

  • CACHE_BYTES_WRITTEN_FROM

  • CACHE_DIRTY_BYTES

  • CACHE_USED_BYTES

  • TICKETS_AVAILABLE_READS

  • TICKETS_AVAILABLE_WRITE

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

  • CONNECTIONS

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

  • CURSORS_TOTAL_OPEN

  • CURSORS_TOTAL_TIMED_OUT

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

  • 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

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

  • 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

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

  • NETWORK_BYTES_IN

  • NETWORK_BYTES_OUT

  • NETWORK_NUM_REQUESTS

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

  • OPLOG_RATE_GB_PER_HOUR

  • OPLOG_MASTER_TIME

  • OPLOG_MASTER_LAG_TIME_DIFF

  • OPLOG_SLAVE_LAG_MASTER_TIME

MongoDB プロセスのoplog の期間とスループット。

  • DB_STORAGE_TOTAL

  • DB_DATA_SIZE_TOTAL

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

  • OPCOUNTER_CMD

  • OPCOUNTER_QUERY

  • OPCOUNTER_UPDATE

  • OPCOUNTER_DELETE

  • OPCOUNTER_GETMORE

  • OPCOUNTER_INSERT

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

  • OPCOUNTER_REPL_CMD

  • OPCOUNTER_REPL_UPDATE

  • OPCOUNTER_REPL_DELETE

  • OPCOUNTER_REPL_INSERT

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

  • 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

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

  • QUERY_EXECUTOR_SCANNED_OBJECTS

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

  • QUERY_TARGETING_SCANNED_PER_RETURNED

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

  • QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED

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

リクエストの例

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/{ALERT-ID}"

応答例

応答ヘッダー

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}

レスポンス本体

{
  "alertConfigId" : "5b43d04087d9d6357de591aa",
  "created" : "2019-07-26T21:12:19Z",
  "currentValue" : {
    "number" : 100,
    "units" : "RAW"
  },
  "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
  "humanReadable" : "Project: testProj
                     Organization: testOrg
                     Alert acknowledged by user@example.com until 2019/10/17 19:48 GMT.
                     Comment: N/A
                     Connections has gone below 1000
                     mycluster.example.com:27017
                     Created: 2019/10/17 15:26 GMT
                     Replica Set: cluster0-shard-0
                     Type: Primary
                     Current Value: 100"
  "groupId" : "535683b3794d371327b",
  "hostnameAndPort" : "mycluster.example.com:27017",
  "id" : "533cb4b8e4b0f1820cdabc7f",
  "lastNotified" : "2019-07-26T21:13:48Z",
  "metricName" : "CONNECTIONS",
  "replicaSetName" : "mycluster",
  "resolved" : "2019-07-26T21:13:42Z",
  "status" : "CLOSED",
  "typeName" : "HOST_METRIC",
  "updated" : "2019-07-26T21:13:42Z",
  "links" : [ ... ]
}

戻る

すべてのアラートの取得

次へ

アラートを 1 つ確認

項目一覧