1 つの組織イベントを取得
必須のロール
このリソースを正常に呼び出すには、API キーに Organization Member
ロールが必要です。
リクエスト
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /orgs/{orgId}/events/{eventId}
リクエスト パス パラメーター
名前 | タイプ | 説明 |
---|---|---|
orgId | string | 目的のイベントに関連付けられた組織の一意の識別子。 |
eventId | string | 目的のイベントの一意の識別子。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
クエリ パラメータ | タイプ | 説明 | default |
---|---|---|---|
pretty | ブール値 | pretty-print で応答を表示 形式。 | false |
envelope | ブール値 | false | |
includeRaw | ブール値 | 出力に 重要
| false |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
---|---|---|
alertId | string | このイベントに関連付けられたアラートの一意の識別子。 |
alertConfigId | string | alertId に関連付けられたアラート構成の一意の識別子。 |
apiKeyId | string | このイベントをトリガーしたAPI キーの一意の識別子。 このフィールドが応答に存在する場合、MongoDB Ops Manager は |
clusterId | string | このイベントが適用されるクラスターの一意の識別子。 |
clusterName | string | このイベントが適用されるクラスターの名前。 |
コレクション | string | イベントが発生したコレクションの名前。 このフィールドは、 eventTypeName がDATA_EXPLORER またはDATA_EXPLORER_CRUD のいずれかの場合に表示される可能性があります。 |
作成済み | string | ISO8601 のタイムスタンプ このイベントがトリガーされたときの日付と時刻形式( UTC ) 。 |
currentValue | オブジェクト | このイベントをトリガーしたメトリクスの現在の値。 |
currentValue .number | 数値 | メトリクスの値。 |
currentValue .units | string | 値に関連する単位。 例メモリ消費を測定するメトリクスにはバイト単位が含まれ、時間を測定するメトリクスには時間単位が含まれます。 指定できる値は次のとおりです。
|
database | string | イベントが発生したデータベースの名前。 このフィールドは、 eventTypeName がDATA_EXPLORER またはDATA_EXPLORER_CRUD のいずれかの場合に表示される可能性があります。 |
eventTypeName | string | このイベントをトリガーした状況の名前。 アラートを生成するイベントの種類を確認するには、「アラートのタイプ 」を参照してください。 MongoDB Ops Managerの監査ログに含まれるイベントの完全なリストについては、「監査イベント 」を参照してください。 |
グループ ID | string | このイベントが発生したプロジェクトの一意の識別子。 |
hostId | string | このイベントが発生したホストの一意の識別子。 |
Hostname | string | このイベントが発生したホストのホスト名、 FQDN 、 IPv4アドレス、またはIPv6アドレス。 |
id | string | このイベントの一意の識別子。 |
is GlobalAdmin | ブール値 | このイベントをトリガーしたユーザーが Global Monitoring Administrator ロールを持っているかどうかを示すフラグ。 |
Links | オブジェクト配列 | サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべての |
metricName | string | 値がしきい値を超えた測定値の名前。 可能な値については、以下を参照してください。 |
opType | string | イベントを生成した操作のタイプ。 このフィールドは、 eventTypeName がDATA_EXPLORER またはDATA_EXPLORER_CRUD のいずれかである場合に表示されます。 |
ポート | 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/orgs/{orgId}/events/{eventId}?pretty=true" \
応答例
応答ヘッダー
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
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 "alertConfigId": "{alertConfigId}", 3 "alertId": "{alertId}", 4 "clusterId": "{clusterId}", 5 "clusterName": "Test Cluster", 6 "created": "2018-06-11T12:34:56Z", 7 "currentValue": { 8 "number": 50, 9 "units": "RAW" 10 }, 11 "eventTypeName": "OUTSIDE_METRIC_THRESHOLD", 12 "groupId": "{groupId}", 13 "hostId": "{hostId}", 14 "hostname": "db.example.com", 15 "id": "{globalAlertId}", 16 "isGlobalAdmin": false, 17 "maintenanceWindowId": "{maintenanceWindowId}", 18 "metricName": "OPCOUNTER_CMD", 19 "orgId": "{orgId}", 20 "port": 27017, 21 "remoteAddress": "192.168.1.1", 22 "replicaSetName": "rs1", 23 "shardName": "sh1", 24 "userId": "{userId}", 25 "username": "john.doe@example.com", 26 "targetUsername": "jane.doe@example.com", 27 "teamId": "{teamId}" 28 }