1 つのグローバルイベントを取得

項目一覧

必須のロール

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

必須のロール

このリソースを正常に呼び出すには、API キーに Global Read Onlyロールが必要です。

リクエスト

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /globalEvents/{eventId}

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

名前	タイプ	説明
eventId	string	目的のイベントの一意の識別子。

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

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

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

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

応答

名前	タイプ	説明
alertId	string	このイベントに関連付けられたアラートの一意の識別子。
alertConfigId	string	`alertId`に関連付けられたアラート構成の一意の識別子。
apiKeyId	string	このイベントをトリガーしたAPI キーの一意の識別子。このフィールドが応答に存在する場合、MongoDB Ops Manager は`userId`フィールドを返しません。
clusterId	string	このイベントが適用されるクラスターの一意の識別子。
clusterName	string	このイベントが適用されるクラスターの名前。
コレクション	string	イベントが発生したコレクションの名前。このフィールドは、 `eventTypeName`が`DATA_EXPLORER`または`DATA_EXPLORER_CRUD`のいずれかの場合に表示される可能性があります。
作成済み	string	ISO8601 のタイムスタンプこのイベントがトリガーされたときの日付と時刻形式（ UTC）。
currentValue	オブジェクト	このイベントをトリガーしたメトリクスの現在の値。
currentValue .number	数値	メトリクスの値。
currentValue .units	string	`currentValue.number`の単位。単位はメトリクスの型によって異なります。指定できる値は次のとおりです。 `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS` 例、メモリ消費を測定するメトリクスには`BYTES`を使用でき、時間を測定するメトリクスには`HOURS`を使用できます。
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 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
metricName	string	値がしきい値を超えた測定値の名前。可能な値については、以下を参照してください。
opType	string	イベントを生成した操作のタイプ。このフィールドは、 `eventTypeName`が`DATA_EXPLORER`または`DATA_EXPLORER_CRUD`のいずれかである場合に表示されます。
ポート	integer	このイベントに関連付けられているホストのポート。
publicKey	string	このイベントをトリガーしたAPIキーに関連付けられた公開キー。このフィールドが応答に存在する場合、MongoDB Ops Manager は`username`フィールドを返しません。
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 は`apiKeyId`フィールドを返しません。
username	string	このイベントをトリガーした MongoDB Ops Manager ユーザーのユーザー名。このフィールドが応答に存在する場合、MongoDB Ops Manager は`publicKey`フィールドを返しません。
accessListEntry	string	イベントの対象となる API キーのアクセスリストエントリ。

リクエストの例

curl --user "{publicKey}:{privateKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/globalEvents/{eventId}?pretty=true" \

応答例

応答ヘッダー

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}

レスポンス本体

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 }

戻る

すべてのグローバルイベントを取得する

メンテナンスウィンドウ

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	}