1 つの組織イベントを取得

項目一覧

必須のロール

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

必須のロール

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

リクエスト

ベースURL: https:// クラウド.mongodb.com/api/public/v 1.0

GET /orgs/{orgId}/events/{eventId}

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

名前	タイプ	説明
orgId	string	目的のイベントに関連付けられた組織の一意の識別子。
eventId	string	目的のイベントの一意の識別子。

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

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

クエリパラメータ	タイプ	説明	default
pretty	ブール値	応答を pretty-print で表示する形式。	`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/orgs/{orgId}/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   "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   "invoiceId": "{invoiceId}",
17   "isGlobalAdmin": false,
18   "maintenanceWindowId": "{maintenanceWindowId}",
19   "metricName": "OPCOUNTER_CMD",
20   "orgId": "{orgId}",
21   "paymentId": "{paymentId}",
22   "port": 27017,
23   "remoteAddress": "192.168.1.1",
24   "replicaSetName": "rs1",
25   "shardName": "sh1",
26   "userId": "{userId}",
27   "username": "john.doe@example.com",
28   "targetUsername": "jane.doe@example.com",
29   "teamId": "{teamId}"
30 }

戻る

すべての組織イベントを取得

すべてのプロジェクトイベントを取得する

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	"invoiceId": "{invoiceId}",
17	"isGlobalAdmin": false,
18	"maintenanceWindowId": "{maintenanceWindowId}",
19	"metricName": "OPCOUNTER_CMD",
20	"orgId": "{orgId}",
21	"paymentId": "{paymentId}",
22	"port": 27017,
23	"remoteAddress": "192.168.1.1",
24	"replicaSetName": "rs1",
25	"shardName": "sh1",
26	"userId": "{userId}",
27	"username": "john.doe@example.com",
28	"targetUsername": "jane.doe@example.com",
29	"teamId": "{teamId}"
30	}

必須のロール

リクエスト

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

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

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

応答

リクエストの例

応答例

応答ヘッダー

レスポンス本体

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

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

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