必須のロール
このリソースを正常に呼び出すには、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形式で表示します。 |
|
envelope | ブール値 |
| |
includeRaw | ブール値 | 出力に 重要: |
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
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 | イベントが発生したデータベースの名前。 このフィールドは、 |
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/orgs/{orgId}/events/{eventId}?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}レスポンス本体
{ "alertConfigId": "{alertConfigId}", "alertId": "{alertId}", "clusterId": "{clusterId}", "clusterName": "Test Cluster", "created": "2018-06-11T12:34:56Z", "currentValue": { "number": 50, "units": "RAW" }, "eventTypeName": "OUTSIDE_METRIC_THRESHOLD", "groupId": "{groupId}", "hostId": "{hostId}", "hostname": "db.example.com", "id": "{globalAlertId}", "isGlobalAdmin": false, "maintenanceWindowId": "{maintenanceWindowId}", "metricName": "OPCOUNTER_CMD", "orgId": "{orgId}", "port": 27017, "remoteAddress": "192.168.1.1", "replicaSetName": "rs1", "shardName": "sh1", "userId": "{userId}", "username": "john.doe@example.com", "targetUsername": "jane.doe@example.com", "teamId": "{teamId}"}