必須のロール
このリソースを正常に呼び出すには、API キーにProject Read Onlyロールが必要です。
リクエスト
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /groups/{groupId}/eventsリクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
グループ ID | string | 目的のイベントに関連付けられたプロジェクトの一意の識別子。 |
リクエスト クエリ パラメータ
一意のクエリ パラメーター
このエンドポイントは、返されたイベントをフィルタリングするために次のクエリ パラメータを受け入れます。
名前 | タイプ | 説明 | default |
|---|---|---|---|
eventType | string | 指定された型のイベントのみを返します。 アラートを生成するイベントの種類を確認するには、「アラートのタイプ 」を参照してください。 MongoDB Ops Managerの監査ログに含まれるイベントの完全なリストについては、「監査イベント 」を参照してください。 | |
includeRaw | ブール値 | 出力に 重要: |
|
minDate | string | 作成された日付が指定されたタイムスタンプ以上のイベントのみを ISO8601 の日付と時刻形式（UTC）で返します。 | |
最大日付 | string | 作成された日付が指定されたタイムスタンプ以下のイベントのみを ISO8601 の日付と時刻形式（UTC）で返します。 |
一般的なクエリ パラメーター
このエンドポイントは、値のリストを返すすべてのエンドポイントに共通のクエリ パラメーターも受け入れます。
名前 | タイプ | 説明 | default |
|---|---|---|---|
pageNum | integer | ページ番号（1 インデックス ベース）。 |
|
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | レスポンス本体を pretty-print 形式にするかどうかを示します。 |
|
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ドキュメント
応答JSONドキュメントには、resultオブジェクトの配列、linkオブジェクトの配列、および検索されたresultオブジェクトの合計数のカウントが含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| 配列 | 配列には、 |
| 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
| 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
各結果は 1 つのイベントです。
名前 | タイプ | 説明 |
|---|---|---|
alertId | string | このイベントに関連付けられたアラートの一意の識別子。 |
alertConfigId | string |
|
apiKeyId | string | このイベントをトリガーしたAPI キーの一意の識別子。 このフィールドが応答に存在する場合、MongoDB Ops Manager は |
clusterId | string | このイベントが適用されるクラスターの一意の識別子。 |
clusterName | string | このイベントが適用されるクラスターの名前。 |
コレクション | string | イベントが発生したコレクションの名前。 このフィールドは、 |
作成済み | string | このイベントがトリガーされたときの ISO の日付と時刻形式（UTC）のタイムスタンプ。8601 |
currentValue | オブジェクト | このイベントをトリガーしたメトリクスの現在の値。 |
currentValue | 数値 | メトリクスの値。 |
currentValue | string | 値に関連する単位。 たとえば、メモリ消費を測定するメトリクスにはバイト単位が含まれ、時間を測定するメトリクスには時間単位が含まれます。 指定できる値は次のとおりです。
|
database | string | イベントが発生したデータベースの名前。 このフィールドは、 |
distinct | オブジェクトの配列 | このイベント中に配置に変更が加えられました。 MongoDB Ops Managerは、変更された内容に応じて異なる要素を返します。特権やロール、復元ジョブ、オートメーションモジュールなど。 この配列とそのオブジェクトのリストはすべて網羅されていません。 |
diffs | string | このイベントで実行された差分の一意の識別子。 |
diffs | オブジェクトの配列 | 指定されたリソースに対して行われた変更のコレクション。 |
diffs | string | 変更が行われたときにアクティビティ フィードのコンソールに表示されるラベル。 |
diffs | string | 変更されたパラメーターの新しい状態。 |
diffs | string | 変更されたパラメーターの初期状態。 |
diffs | string | 変更されたパラメーターの名前。 |
diffs | string | このリソースに加えられた変更の内容。
|
diffs | string | 変更が行われたリソース。
|
eventTypeName | string | このイベントをトリガーした状況の名前。 アラートを生成するイベントの種類を確認するには、「アラートのタイプ 」を参照してください。 MongoDB Ops Managerの監査ログに含まれるイベントの完全なリストについては、「監査イベント 」を参照してください。 |
グループ ID | string | このイベントが発生したプロジェクトの一意の識別子。 |
hostId | string | このイベントが発生したホストの一意の識別子。 |
Hostname | string | このイベントが発生したホストのホスト名、FQDN、IPv 4アドレス、または IPv6 アドレス。 |
id | string | このイベントの一意の識別子。 |
is GlobalAdmin | ブール値 | このイベントをトリガーしたユーザーが |
Links | オブジェクト配列 | サブリソースまたは関連リソースへの 1 つ以上のリンク。応答内のすべての |
metricName | string | 値がしきい値を超えた測定値の名前。 |
opType | string | イベントを生成した操作のタイプ。 このフィールドは、 |
ポート | integer | このイベントに関連付けられているホストのポート。 |
publicKey | string | このイベントをトリガーしたAPIキーに関連付けられた公開キー。 このフィールドが応答に存在する場合、MongoDB Ops Manager は |
生 | ドキュメント | イベントに関する追加のメタ情報。 このフィールドは、 重要: |
remoteAddress | string | イベントをトリガーした MongoDB Ops Manager ユーザー（userId） に関連付けられた IP アドレス。 |
ReplicaSetName | string | レプリカセットの名前。 |
shardName | string | イベントに関連付けられたシャードの名前。 |
targetPublicKey | string | イベントの対象となるAPI キーの公開キー。 |
targetUsername | string | このイベントの対象となる MongoDB Ops Manager ユーザーのユーザー名。 |
teamId | string | このイベントに関連付けられた MongoDB Ops Manager チームの一意の識別子。 |
userId | string | このイベントをトリガーした MongoDB Ops Manager ユーザーの一意の識別子。 このフィールドが応答に存在する場合、MongoDB Ops Manager は |
username | string | このイベントをトリガーした MongoDB Ops Manager ユーザーのユーザー名。 このフィールドが応答に存在する場合、MongoDB Ops Manager は |
accessListEntry | string | イベントの対象となる API キーのアクセス リスト エントリ。 |
リクエストの例
curl --user "{publicKey}:{privateKey}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{groupId}/events?pretty=true"応答例
応答ヘッダー
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-aliveHTTP/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}レスポンス本体
{ "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{groupId}/events?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" }, { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{groupId}/events?pretty=true&itemsPerPage=100&pageNum=2", "rel" : "next" } ], "results" : [ { "created" : "2020-07-13T21:28:37Z", "diffs" : [ { "id" : "admin@admin", "name" : null, "params" : [ { "display" : "Added Privilege", "new" : "config.system.sessions: moveChunk", "old" : null, "param" : "config.system.sessions: moveChunk" }, { "display" : "Added Privilege", "new" : "config.system.sessions: splitChunk", "old" : null, "param" : "config.system.sessions: splitChunk" }, { "display" : "Added Privilege", "new" : "config.system.sessions: splitVector", "old" : null, "param" : "config.system.sessions: splitVector" } ], "priviileges" : [ { "actions" : [ "moveChunk" ], "resource" : { "collection" : "system.sessions", "db" : "config" } }, { "actions" : [ "moveChunk" ], "resource" : { "collection" : "", "db" : "" } }, { "actions" : [ "enableSharding" ], "resource" : { "cluster" : true } }, { "actions" : [ "cleanupOrphaned" ], "resource" : { "cluster" : true } }, { "actions" : [ "flushRouterConfig" ], "resource" : { "cluster" : true } }, { "actions" : [ "splitChunk" ], "resource" : { "collection" : "system.sessions", "db" : "config" } }, { "actions" : [ "splitChunk" ], "resource" : { "collection" : "", "db" : "" } }, { "actions" : [ "splitVector" ], "resource" : { "collection" : "system.sessions", "db" : "config" } }, { "actions" : [ "viewRole" ], "resource" : { "collection" : "", "db" : "" } } ], "roles" : [ { "db" : "admin", "role" : "readWriteAnyDatabase" }, { "db" : "admin", "role" : "dbAdminAnyDatabase" }, { "db" : "admin", "role" : "enableSharding" }, { "db" : "admin", "role" : "backup" }, { "db" : "admin", "role" : "clusterMonitor" } ], "status" : "MODIFIED", "type" : "ROLES" }, { "id" : "sample-dataset-load@admin", "name" : null, "params" : [ ], "priviileges" : null, "roles" : [ { "db" : "admin", "role" : "readWriteAnyDatabase" } ], "status" : "NEW", "type" : "USERS" }, { "id" : "10.16.0.6482-1", "name" : null, "params" : [ { "display" : "Version", "new" : "10.16.0.6482-1", "old" : "10.12.0.6179-1", "param" : "version" } ], "status" : "MODIFIED", "type" : "AUTOMATION_AGENT" } ], "eventTypeName" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", "groupId" : "{groupId}", "id" : "{eventId}", "isGlobalAdmin" : false, "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{groupId}/events/{eventId}", "rel" : "self" } ] }], "totalCount" : 1}