Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
リソース
/
測定値とアラート
/
イベント

1 つのプロジェクト イベントを取得する

項目一覧

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

必須のロール

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

リクエスト

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

GET /groups/{groupId}/events/{eventId}

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

名前
タイプ
説明
グループ ID
string
目的のイベントに関連付けられたプロジェクトの一意の識別子。
eventId
string
目的のイベントの一意の識別子。

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

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

クエリ パラメータ
タイプ
説明
default
pretty
ブール値
false
envelope
ブール値
false
includeRaw
ブール値

出力にrawドキュメントを含めるかどうかを指定します。 rawドキュメントには、イベントに関する追加のメタ情報が含まれています。

重要: rawドキュメントの値は変更される可能性があります。 形式モニタリングの場合、 rawの値に依存しないでください。

false

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

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

応答

名前
タイプ
説明
alertId
string
このイベントに関連付けられたアラートの一意の識別子。
alertConfigId
string
alertIdに関連付けられたアラート構成の一意の識別子。
apiKeyId
string

このイベントをトリガーしたAPI キーの一意の識別子。

このフィールドがレスポンスにある場合、Cloud Manager はuserIdフィールドを返しません。

clusterId
string
このイベントが適用されるクラスターの ID。
clusterName
string
このイベントが適用されるクラスターの名前。
コレクション
string
イベントが発生したコレクションの名前。 このフィールドは、 eventTypeNameがDATA_EXPLORERまたはDATA_EXPLORER_CRUDのいずれかの場合に表示される可能性があります。
作成済み
string
ISO8601 のタイムスタンプ このイベントがトリガーされたときの日付と時刻形式（ UTC ） 。
currentValue
オブジェクト
このイベントをトリガーしたメトリクスの現在の値。
currentValue
.number
数値
メトリクスの値。
currentValue
.units
string

値に関連する単位。

たとえば、メモリ消費を測定するメトリクスにはバイト単位が含まれ、時間を測定するメトリクスには時間単位が含まれます。

指定できる値は次のとおりです。

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

database
string
イベントが発生したデータベースの名前。 このフィールドは、 eventTypeNameがDATA_EXPLORERまたはDATA_EXPLORER_CRUDのいずれかの場合に表示される可能性があります。
eventTypeName
string

このイベントをトリガーした状況の名前。

アラートを生成するイベントの種類を確認するには、「アラートのタイプ 」を参照してください。

グループ ID
string
このイベントが発生したプロジェクトの ID。
hostId
string
このイベントが発生したホストの ID。
Hostname
string
このイベントが発生したホストのホスト名、 FQDN 、 IPv4アドレス、またはIPv6アドレス。
id
string
このイベントの一意の識別子。
invoiceId
string
このイベントに関連付けられた請求書の一意な識別子。
is GlobalAdmin
ブール値
このイベントをトリガーしたユーザーが MongoDB の従業員であるかどうかを示すフラグ。
Links
オブジェクト配列

サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべてのlinks配列には、 selfと呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様 で説明されています。

metricName
string

値がしきい値を超えた測定値の名前。

可能な値については、以下を参照してください。

opType
string
イベントを生成した操作のタイプ。 このフィールドは、 eventTypeNameがDATA_EXPLORERまたはDATA_EXPLORER_CRUDのいずれかである場合に表示されます。
PaymentId
string
このイベントに関連付けられた請求書支払いの一意の識別子。
ポート
integer
このイベントに関連付けられているホストのポート。
publicKey
string

このイベントをトリガーしたAPIキーに関連付けられた公開キー。

このフィールドがレスポンスにある場合、Cloud Manager はusernameフィールドを返しません。

生
ドキュメント

イベントに関する追加のメタ情報。 このフィールドは、 includeRawクエリ パラメータがtrueの場合にのみ表示されます。

重要: rawドキュメントの値は変更される可能性があります。 形式モニタリングの場合、 rawの値に依存しないでください。

remoteAddress
string
イベントをトリガーした Cloud Manager ユーザー（userId）に関連付けられた IP アドレス。
ReplicaSetName
string
レプリカセットの名前。
shardName
string
イベントに関連付けられたシャードの名前。
targetPublicKey
string
イベントの対象となる API キーの公開キー。
targetUsername
string
このイベントの対象となる Cloud Manager ユーザーのユーザー名。
teamId
string
このイベントに関連付けられた Cloud Manager チームの一意の識別子です。
userId
string

このイベントをトリガーした Cloud Manager ユーザーの一意の識別子。

このフィールドがレスポンスにある場合、Cloud Manager はapiKeyIdフィールドを返しません。

username
string

このイベントをトリガーした Cloud Manager ユーザーのユーザー名。

このフィールドがレスポンスにある場合、Cloud Manager はpublicKeyフィールドを返しません。

accessListEntry
string
イベントの対象となる API キーのアクセス リスト エントリ。

リクエストの例

curl --user "{publicKey}:{privateKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{groupId}/events/{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  "created" : "2020-07-13T21:28:37Z",
3  "diffs" : [ {
4    "id" : "admin@admin",
5    "name" : null,
6    "params" : [ {
7      "display" : "Added Privilege",
8      "new" : "config.system.sessions: moveChunk",
9      "old" : null,
10      "param" : "config.system.sessions: moveChunk"
11    }, {
12      "display" : "Added Privilege",
13      "new" : "config.system.sessions: splitChunk",
14      "old" : null,
15      "param" : "config.system.sessions: splitChunk"
16    }, {
17      "display" : "Added Privilege",
18      "new" : "config.system.sessions: splitVector",
19      "old" : null,
20      "param" : "config.system.sessions: splitVector"
21    } ],
22    "priviileges" : [ {
23      "actions" : [ "moveChunk" ],
24      "resource" : {
25        "collection" : "system.sessions",
26        "db" : "config"
27      }
28    }, {
29      "actions" : [ "moveChunk" ],
30      "resource" : {
31        "collection" : "",
32        "db" : ""
33      }
34    }, {
35      "actions" : [ "enableSharding" ],
36      "resource" : {
37        "cluster" : true
38      }
39    }, {
40      "actions" : [ "cleanupOrphaned" ],
41      "resource" : {
42        "cluster" : true
43      }
44    }, {
45      "actions" : [ "flushRouterConfig" ],
46      "resource" : {
47        "cluster" : true
48      }
49    }, {
50      "actions" : [ "splitChunk" ],
51      "resource" : {
52        "collection" : "system.sessions",
53        "db" : "config"
54      }
55    }, {
56      "actions" : [ "splitChunk" ],
57      "resource" : {
58        "collection" : "",
59        "db" : ""
60      }
61    }, {
62      "actions" : [ "splitVector" ],
63      "resource" : {
64        "collection" : "system.sessions",
65        "db" : "config"
66      }
67    }, {
68      "actions" : [ "viewRole" ],
69      "resource" : {
70        "collection" : "",
71        "db" : ""
72      }
73    } ],
74    "roles" : [ {
75      "db" : "admin",
76      "role" : "readWriteAnyDatabase"
77    }, {
78      "db" : "admin",
79      "role" : "dbAdminAnyDatabase"
80    }, {
81      "db" : "admin",
82      "role" : "enableSharding"
83    }, {
84      "db" : "admin",
85      "role" : "backup"
86    }, {
87      "db" : "admin",
88      "role" : "clusterMonitor"
89    } ],
90    "status" : "MODIFIED",
91    "type" : "ROLES"
92  }
93}

戻る

すべて取得（プロジェクト）

次へ

メンテナンスウィンドウ