すべてのプロジェクト イベントを取得する
項目一覧
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
必須のロール
このリソースを正常に呼び出すには、API キーに Project Read Only
ロールが必要です。
リクエスト
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
GET /groups/{groupId}/events
リクエスト パス パラメーター
名前 | タイプ | 説明 |
---|---|---|
グループ ID | string | 目的のイベントに関連付けられたプロジェクトの一意の識別子。 |
リクエスト クエリ パラメータ
一意のクエリ パラメーター
このエンドポイントは、返されたイベントをフィルタリングするために次のクエリ パラメータを受け入れます。
名前 | タイプ | 説明 | default |
---|---|---|---|
eventType | string | 指定された型のイベントのみを返します。 アラートを生成するイベントの種類を確認するには、「アラートのタイプ 」を参照してください。 | |
includeRaw | ブール値 | 出力に 重要: | false |
minDate | string | ISO8601 で作成された日付が指定されたタイムスタンプ以上のイベントのみを返す UTC の日付と時刻形式。 | |
最大日付 | string | ISO8601 の作成日が指定されたタイムスタンプ以下のイベントのみを返す UTC の日付と時刻形式。 |
一般的なクエリ パラメーター
このエンドポイントは、値のリストを返すすべてのエンドポイントに共通のクエリ パラメーターも受け入れます。
名前 | タイプ | 説明 | default | ||||||
---|---|---|---|---|---|---|---|---|---|
pageNum | integer | ページ番号(1 インデックス ベース)。 | 1 | ||||||
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 | 100 | ||||||
pretty | ブール値 | レスポンス本体が pretty-print 内であるかどうかを示します 形式。 | false | ||||||
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ドキュメント
レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。
名前 | タイプ | 説明 |
---|---|---|
results | 配列 | 配列には、 results 埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。 |
links | 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
totalCount | 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results
embeddedDocument
各結果は 1 つのイベントです。
名前 | タイプ | 説明 |
---|---|---|
alertId | string | このイベントに関連付けられたアラートの一意の識別子。 |
alertConfigId | string | alertId に関連付けられたアラート構成の一意の識別子。 |
apiKeyId | string | このイベントをトリガーしたAPI キーの一意の識別子。 このフィールドがレスポンスにある場合、Cloud Manager は |
clusterId | string | このイベントが適用されるクラスターの ID。 |
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 | このイベントをトリガーした状況の名前。 アラートを生成するイベントの種類を確認するには、「アラートのタイプ 」を参照してください。 |
グループ ID | string | このイベントが発生したプロジェクトの ID。 |
hostId | string | このイベントが発生したホストの ID。 |
Hostname | string | このイベントが発生したホストのホスト名、 FQDN 、 IPv4アドレス、またはIPv6アドレス。 |
id | string | このイベントの一意の識別子。 |
invoiceId | string | このイベントに関連付けられた請求書の一意な識別子。 |
is GlobalAdmin | ブール値 | このイベントをトリガーしたユーザーが MongoDB の従業員であるかどうかを示すフラグ。 |
Links | オブジェクト配列 | サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべての |
metricName | string | 値がしきい値を超えた測定値の名前。 可能な値については、以下を参照してください。 |
opType | string | イベントを生成した操作のタイプ。 このフィールドは、 eventTypeName がDATA_EXPLORER またはDATA_EXPLORER_CRUD のいずれかである場合に表示されます。 |
PaymentId | string | このイベントに関連付けられた請求書支払いの一意の識別子。 |
ポート | integer | このイベントに関連付けられているホストのポート。 |
publicKey | string | このイベントをトリガーしたAPIキーに関連付けられた公開キー。 このフィールドがレスポンスにある場合、Cloud Manager は |
生 | ドキュメント | イベントに関する追加のメタ情報。 このフィールドは、 重要: |
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 は |
username | string | このイベントをトリガーした Cloud Manager ユーザーのユーザー名。 このフィールドがレスポンスにある場合、Cloud Manager は |
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?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 "links" : [ { 3 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{groupId}/events?pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 }, { 6 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{groupId}/events?pretty=true&itemsPerPage=100&pageNum=2", 7 "rel" : "next" 8 } ], 9 "results" : [ { 10 "created" : "2020-07-13T21:28:37Z", 11 "diffs" : [ { 12 "id" : "admin@admin", 13 "name" : null, 14 "params" : [ { 15 "display" : "Added Privilege", 16 "new" : "config.system.sessions: moveChunk", 17 "old" : null, 18 "param" : "config.system.sessions: moveChunk" 19 }, { 20 "display" : "Added Privilege", 21 "new" : "config.system.sessions: splitChunk", 22 "old" : null, 23 "param" : "config.system.sessions: splitChunk" 24 }, { 25 "display" : "Added Privilege", 26 "new" : "config.system.sessions: splitVector", 27 "old" : null, 28 "param" : "config.system.sessions: splitVector" 29 } ], 30 "priviileges" : [ { 31 "actions" : [ "moveChunk" ], 32 "resource" : { 33 "collection" : "system.sessions", 34 "db" : "config" 35 } 36 }, { 37 "actions" : [ "moveChunk" ], 38 "resource" : { 39 "collection" : "", 40 "db" : "" 41 } 42 }, { 43 "actions" : [ "enableSharding" ], 44 "resource" : { 45 "cluster" : true 46 } 47 }, { 48 "actions" : [ "cleanupOrphaned" ], 49 "resource" : { 50 "cluster" : true 51 } 52 }, { 53 "actions" : [ "flushRouterConfig" ], 54 "resource" : { 55 "cluster" : true 56 } 57 }, { 58 "actions" : [ "splitChunk" ], 59 "resource" : { 60 "collection" : "system.sessions", 61 "db" : "config" 62 } 63 }, { 64 "actions" : [ "splitChunk" ], 65 "resource" : { 66 "collection" : "", 67 "db" : "" 68 } 69 }, { 70 "actions" : [ "splitVector" ], 71 "resource" : { 72 "collection" : "system.sessions", 73 "db" : "config" 74 } 75 }, { 76 "actions" : [ "viewRole" ], 77 "resource" : { 78 "collection" : "", 79 "db" : "" 80 } 81 } ], 82 "roles" : [ { 83 "db" : "admin", 84 "role" : "readWriteAnyDatabase" 85 }, { 86 "db" : "admin", 87 "role" : "dbAdminAnyDatabase" 88 }, { 89 "db" : "admin", 90 "role" : "enableSharding" 91 }, { 92 "db" : "admin", 93 "role" : "backup" 94 }, { 95 "db" : "admin", 96 "role" : "clusterMonitor" 97 } ], 98 "status" : "MODIFIED", 99 "type" : "ROLES" 100 }, { 101 "id" : "sample-dataset-load@admin", 102 "name" : null, 103 "params" : [ ], 104 "priviileges" : null, 105 "roles" : [ { 106 "db" : "admin", 107 "role" : "readWriteAnyDatabase" 108 } ], 109 "status" : "NEW", 110 "type" : "USERS" 111 }, { 112 "id" : "10.16.0.6482-1", 113 "name" : null, 114 "params" : [ { 115 "display" : "Version", 116 "new" : "10.16.0.6482-1", 117 "old" : "10.12.0.6179-1", 118 "param" : "version" 119 } ], 120 "status" : "MODIFIED", 121 "type" : "AUTOMATION_AGENT" 122 } ], 123 "eventTypeName" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", 124 "groupId" : "{groupId}", 125 "id" : "{eventId}", 126 "isGlobalAdmin" : false, 127 "links" : [ { 128 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{groupId}/events/{eventId}", 129 "rel" : "self" 130 } ] 131 }], 132 "totalCount" : 1 133 }