アラートを 1 つ取得

項目一覧

Resource

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

注意

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

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/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 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前	説明
状態	HTTPレスポンスコード
envelope	期待される応答本体

false

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

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

応答

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

名前	タイプ	説明
`acknowledged` `Until`	string	ISO8601 のタイムスタンプアラートが確認されたまでの日付と時刻形式（ UTC）。アラートが確認された場合、MongoDB Ops Manager はこの値を返します。
`acknowledgement` `Comment`	string	アラートを確認したユーザーが残すコメント。アラートが確認された場合、MongoDB Ops Manager はこの値を返します。
`acknowledging` `Username`	string	アラートを確認したユーザーのユーザー名。アラートが確認された場合、MongoDB Ops Manager はこの値を返します。
`alertConfigId`	string	このアラートをトリガーしたアラート構成の一意の識別子。
`clusterId`	string	このアラートが適用されるクラスターの一意の識別子。 MongoDB Ops Manager は次の場合にこの値を返します。 `"eventTypeName" : "SHARDED_CLUSTER"`
`clusterName`	string	このアラートが適用されるクラスターの名前。 MongoDB Ops Manager は次の場合にこの値を返します。 `"eventTypeName" : "SHARDED_CLUSTER"`
`created`	string	ISO8601 のタイムスタンプアラートが開かれたときの UTC の日付と時刻形式。
`currentValue`	オブジェクト	アラートをトリガーしたメトリクスの現在の値。 MongoDB Ops Manager は`"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"`の場合にこの値を返します。
`currentValue` `.number`	数値	メトリクスの値。
`currentValue` `.units`	string	値の単位。値は、メトリクスの型によって異なります。例メモリ消費を測定するメトリクスにはバイト単位が含まれ、時間を測定するメトリクスには時間単位が含まれます。 MongoDB Ops 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` Backup - `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 `ATTEMPT_KILLOP_AUDIT` `ATTEMPT_KILLSESSION_AUDIT` `DB_PROFILER_DISABLE_AUDIT` `DB_PROFILER_ENABLE_AUDIT` `DISABLE_HOST_AUDIT` `HIDE_AND_DISABLE_HOST_AUDIT` `HIDE_HOST_AUDIT` `HOST_DOWN` `HOST_DOWNGRADED` `HOST_IP_CHANGED_AUDIT` `HOST_NOW_PRIMARY` `HOST_NOW_SECONDARY` `HOST_NOW_STANDALONE` `HOST_RECOVERED` `HOST_RECOVERING` `HOST_SECURITY_CHECKUP_NOT_MET` `HOST_SSL_CERTIFICATE_CURRENT` `HOST_SSL_CERTIFICATE_STALE` `HOST_UP` `HOST_UPGRADED` `INSIDE_METRIC_THRESHOLD` `NEW_HOST` `OUTSIDE_METRIC_THRESHOLD` `PAUSE_HOST_AUDIT` `RESUME_HOST_AUDIT` `UNDELETE_HOST_AUDIT` `VERSION_BEHIND` `VERSION_CHANGED` `VERSION_CURRENT` 組織 `ALL_ORG_USERS_HAVE_MFA` `ORG_API_KEY_ADDED` `ORG_API_KEY_DELETED` `ORG_EMPLOYEE_ACCESS_RESTRICTED` `ORG_EMPLOYEE_ACCESS_UNRESTRICTED` `ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED` `ORG_PUBLIC_API_ACCESS_LIST_REQUIRED` `ORG_RENAMED` `ORG_TWO_FACTOR_AUTH_OPTIONAL` `ORG_TWO_FACTOR_AUTH_REQUIRED` `ORG_USERS_WITHOUT_MFA` プロジェクト `ALL_USERS_HAVE_MULTI_FACTOR_AUTH` `USERS_WITHOUT_MULTI_FACTOR_AUTH` レプリカセット `CONFIGURATION_CHANGED` `ENOUGH_HEALTHY_MEMBERS` `MEMBER_ADDED` `MEMBER_REMOVED` `MULTIPLE_PRIMARIES` `NO_PRIMARY` `ONE_PRIMARY` `TOO_FEW_HEALTHY_MEMBERS` `TOO_MANY_ELECTIONS` `TOO_MANY_UNHEALTHY_MEMBERS` チーム `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 `INVITED_TO_GROUP` `INVITED_TO_ORG` `JOIN_GROUP_REQUEST_APPROVED_AUDIT` `JOIN_GROUP_REQUEST_DENIED_AUDIT` `JOINED_TEAM` `REMOVED_FROM_TEAM` `REQUESTED_TO_JOIN_GROUP` MongoDB Ops Managerの監査ログに含まれるイベントの完全なリストについては、「監査イベント」を参照してください。
`groupId`	string	このアラートが開かれたグループの一意の識別子。
`hostId`	string	メトリクスが含まれるホストの一意の識別子。 `"eventTypeName"`が次のいずれかに設定されている場合、MongoDB Ops Manager はこの値を返します。 `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`hostnameAndPort`	string	アラートが適用される各ホストのホスト名とポート。これは、ホスト名、 FQDN 、 IPv4アドレス、またはIPv6アドレスにすることができます。 `"eventTypeName"`が次のいずれかに設定されている場合、MongoDB Ops Manager はこの値を返します。 `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`id`	string	アラートの一意の識別子です。
`lastNotified`	string	ISO8601 のタイムスタンプこのアラートの最後の通知が送信された日時の UTC 形式の日付と時刻形式。通知が送信された場合、MongoDB Ops Manager はこの値を返します。
`links`	オブジェクトの配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
`metricName`	string	値がしきい値を超えた測定値の名前。 MongoDB Ops Manager では、 `"eventTypeName"`が`OUTSIDE_METRIC_THRESHOLD`に設定されている場合にこの値が返されます。可能な値については、「アラートの測定タイプ」を参照してください。
`replicaSetName`	string	レプリカセットの名前。 `"eventTypeName"`が次のいずれかに設定されている場合、MongoDB Ops Manager はこの値を返します。 `BACKUP` `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`resolved`	string	ISO8601 のタイムスタンプアラートが閉じられたときの日付と時刻形式（ UTC）。 MongoDB Ops Manager は`"status" : "CLOSED"`の場合にこの値を返します。
`status`	string	アラートの現在の状態。 MongoDB Ops Manager は次のいずれかを返すことができます。 `TRACKING` アラート条件は存在しますが、定義された通知遅延を超えて持続していません。詳細については、「リクエストクエリパラメーター」を参照してください。 `OPEN` `CLOSED` `CANCELLED`
`sourceTypeName`	string	`"eventTypeName" : "BACKUP"`の場合にバックアップされるホストのタイプ。 MongoDB Ops 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 プロセスのロックを待機している操作の数。 MongoDB Ops Managerは、storage engine のタイプに基づいてこれらの値を計算します。
`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`	MongoDB プロセスのoplog の期間とスループット。
`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`	返されたドキュメント数に対するスキャンされたドキュメント数の比率。

リクエストの例

 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET "https://<ops-manager-host>/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 つ確認

アラートを 1 つ取得.leafygreen-ui-m0pgrr{-webkit-align-self:center;-ms-flex-item-align:center;align-self:center;padding:0 10px;visibility:hidden;}.leafygreen-ui-a30zj9{color:#889397;vertical-align:middle;margin-top:-2px;}.css-fmznk8{margin-top:-85px;position:absolute;padding-bottom:2px;}

注意