アラートを 1 つ確認

項目一覧

Resource

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

注意

グループとプロジェクトは同義語です。あなたの {PROJECT-ID}はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。このページでは、説明を参照するときに、より一般的な用語のグループを使用します。エンドポイントはドキュメントに記載されているままです。

Resource

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

PATCH /groups/{PROJECT-ID}/alerts/{ALERT-ID}

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

Parameter	タイプ	必要性	説明
`PROJECT-ID`	string	必須	このアラートが設定されているプロジェクトの一意の識別子。
`ALERT-ID`	string	必須	アラートの一意の識別子です。

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

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

名前	説明
状態	HTTPレスポンスコード
envelope	期待される応答本体

false

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

フィールド	タイプ	必要性	説明
`acknowledged` `Until`	string	条件付き	ISO8601 のタイムスタンプアラートが確認されるまで、 UTC の日付と時刻形式。アラートを「永久」に確認するには、フィールドの値を数年後に設定します。を 100 年後に設定することをお勧めします。確認済みのアラートを未確認にするには、リクエストからこのパラメータを削除します。
`acknowledgement` `Comment`	string	任意	この確認応答の理由のテキスト説明。 MongoDB Ops Manager は、アラートが確認されたことを示すメッセージの横にコメントを表示します。

応答

返されるドキュメント内のフィールドは、アラートの種類によって異なります。

名前	タイプ	説明
`acknowledged` `Until`	string	ISO8601 のタイムスタンプアラートが確認されたまでの日付と時刻形式（ UTC）。アラートが確認された場合、MongoDB Ops Manager はこの値を返します。
`acknowledgement` `Comment`	string	アラートを確認したユーザーが残すコメント。アラートが確認された場合、MongoDB Ops Manager はこの値を返します。
`acknowledging` `Username`	string	アラートを確認したユーザーのユーザー名。アラートが確認された場合、MongoDB Ops Manager はこの値を返します。
`alertConfigId`	string	このアラートをトリガーしたアラート構成の一意の識別子。
`clusterId`	string	このアラートが適用されるクラスターの一意の識別子。 MongoDB Ops Manager は次の場合にこの値を返します。 `"eventTypeName" : "SHARDED_CLUSTER"`
`clusterName`	string	このアラートが適用されるクラスターの名前。 MongoDB Ops Manager は次の場合にこの値を返します。 `"eventTypeName" : "SHARDED_CLUSTER"`
`created`	string	ISO8601 のタイムスタンプアラートが開かれたときの UTC の日付と時刻形式。
`currentValue`	オブジェクト	アラートをトリガーしたメトリクスの現在の値。 MongoDB Ops Manager は`"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"`の場合にこの値を返します。
`currentValue` `.number`	数値	メトリクスの値。
`currentValue` `.units`	string	値の単位。値は、メトリクスの型によって異なります。例メモリ消費を測定するメトリクスにはバイト単位が含まれ、時間を測定するメトリクスには時間単位が含まれます。 MongoDB Ops Manager は次を返すことができます。 `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS`
`eventTypeName`	string	アラートをトリガーしたイベントの名前。指定できる値は次のとおりです。エージェント `AUTOMATION_AGENT_DOWN` `AUTOMATION_AGENT_UP` `BACKUP_AGENT_CONF_CALL_FAILURE` `BACKUP_AGENT_DOWN` `BACKUP_AGENT_UP` `BACKUP_AGENT_VERSION_BEHIND` `BACKUP_AGENT_VERSION_CURRENT` `MONITORING_AGENT_DOWN` `MONITORING_AGENT_UP` `MONITORING_AGENT_VERSION_BEHIND` `MONITORING_AGENT_VERSION_CURRENT` `NEW_AGENT` オートメーション構成 `AUTOMATION_CONFIG_PUBLISHED_AUDIT` Backup - `BAD_CLUSTERSHOTS` - `CLUSTER_BLACKLIST_UPDATED_AUDIT` - `CLUSTER_CHECKKPOINT_UPDATED_AUDIT` - `CLUSTER_CREDENTIAL_UPDATED_AUDIT` - `CLUSTER_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` - `CLUSTER_STATE_CHANGED_AUDIT` - `CLUSTER_STORAGE_ENGINE_UPDATED_AUDIT` - `CLUSTERSHOT_DELETED_AUDIT` - `CLUSTERSHOT_EXPIRY_UPDATED_AUDIT` - `CONSISTENT_BACKUP_CONFIGURATION` - `GOOD_CLUSTERSHOT` - `INCONSISTENT_BACKUP_CONFIGURATION` - `INITIAL_SYNC_FINISHED_AUDIT` - `INITIAL_SYNC_STARTED_AUDIT` - `OPLOG_BEHIND` - `OPLOG_CURRENT` - `RESTORE_REQUESTED_AUDIT` - `RESYNC_PERFORMED` - `RESYNC_REQUIRED` - `RS_BLACKLIST_UPDATED_AUDIT` - `RS_CREDENTIAL_UPDATED_AUDIT` - `RS_ROTATE_MASTER_KEY_AUDIT` - `RS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` - `RS_STATE_CHANGED_AUDIT` - `RS_STORAGE_ENGINE_UPDATED_AUDIT` - `SNAPSHOT_DELETED_AUDIT` - `SNAPSHOT_EXPIRY_UPDATED_AUDIT` - `SYNC_PENDING_AUDIT` - `SYNC_REQUIRED_AUDIT` BI Connector `BI_CONNECTOR_DOWN` `BI_CONNECTOR_UP` クラスター `CLUSTER_MONGOS_IS_MISSING` `CLUSTER_MONGOS_IS_PRESENT` `SHARD_ADDED` `SHARD_REMOVED` Data Explorer のアクセス `DATA_EXPLORER` `DATA_EXPLORER_CRUD` Host `ATTEMPT_KILLOP_AUDIT` `ATTEMPT_KILLSESSION_AUDIT` `DB_PROFILER_DISABLE_AUDIT` `DB_PROFILER_ENABLE_AUDIT` `DISABLE_HOST_AUDIT` `HIDE_AND_DISABLE_HOST_AUDIT` `HIDE_HOST_AUDIT` `HOST_DOWN` `HOST_DOWNGRADED` `HOST_IP_CHANGED_AUDIT` `HOST_NOW_PRIMARY` `HOST_NOW_SECONDARY` `HOST_NOW_STANDALONE` `HOST_RECOVERED` `HOST_RECOVERING` `HOST_SECURITY_CHECKUP_NOT_MET` `HOST_SSL_CERTIFICATE_CURRENT` `HOST_SSL_CERTIFICATE_STALE` `HOST_UP` `HOST_UPGRADED` `INSIDE_METRIC_THRESHOLD` `NEW_HOST` `OUTSIDE_METRIC_THRESHOLD` `PAUSE_HOST_AUDIT` `RESUME_HOST_AUDIT` `UNDELETE_HOST_AUDIT` `VERSION_BEHIND` `VERSION_CHANGED` `VERSION_CURRENT` 組織 `ALL_ORG_USERS_HAVE_MFA` `ORG_API_KEY_ADDED` `ORG_API_KEY_DELETED` `ORG_EMPLOYEE_ACCESS_RESTRICTED` `ORG_EMPLOYEE_ACCESS_UNRESTRICTED` `ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED` `ORG_PUBLIC_API_ACCESS_LIST_REQUIRED` `ORG_RENAMED` `ORG_TWO_FACTOR_AUTH_OPTIONAL` `ORG_TWO_FACTOR_AUTH_REQUIRED` `ORG_USERS_WITHOUT_MFA` プロジェクト `ALL_USERS_HAVE_MULTI_FACTOR_AUTH` `USERS_WITHOUT_MULTI_FACTOR_AUTH` レプリカセット `CONFIGURATION_CHANGED` `ENOUGH_HEALTHY_MEMBERS` `MEMBER_ADDED` `MEMBER_REMOVED` `MULTIPLE_PRIMARIES` `NO_PRIMARY` `ONE_PRIMARY` `TOO_FEW_HEALTHY_MEMBERS` `TOO_MANY_ELECTIONS` `TOO_MANY_UNHEALTHY_MEMBERS` チーム `TEAM_ADDED_TO_GROUP` `TEAM_CREATED` `TEAM_DELETED` `TEAM_NAME_CHANGED` `TEAM_REMOVED_FROM_GROUP` `TEAM_ROLES_MODIFIED` `TEAM_UPDATED` `USER_ADDED_TO_TEAM` user `INVITED_TO_GROUP` `INVITED_TO_ORG` `JOIN_GROUP_REQUEST_APPROVED_AUDIT` `JOIN_GROUP_REQUEST_DENIED_AUDIT` `JOINED_TEAM` `REMOVED_FROM_TEAM` `REQUESTED_TO_JOIN_GROUP` MongoDB Ops Managerの監査ログに含まれるイベントの完全なリストについては、「監査イベント」を参照してください。
`groupId`	string	このアラートが開かれたグループの一意の識別子。
`hostId`	string	メトリクスが含まれるホストの一意の識別子。 `"eventTypeName"`が次のいずれかに設定されている場合、MongoDB Ops Manager はこの値を返します。 `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`hostnameAndPort`	string	アラートが適用される各ホストのホスト名とポート。これは、ホスト名、 FQDN 、 IPv4アドレス、またはIPv6アドレスにすることができます。 `"eventTypeName"`が次のいずれかに設定されている場合、MongoDB Ops Manager はこの値を返します。 `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`id`	string	アラートの一意の識別子です。
`lastNotified`	string	ISO8601 のタイムスタンプこのアラートの最後の通知が送信された日時の UTC 形式の日付と時刻形式。通知が送信された場合、MongoDB Ops Manager はこの値を返します。
`links`	オブジェクトの配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
`metricName`	string	値がしきい値を超えた測定値の名前。 MongoDB Ops Manager では、 `"eventTypeName"`が`OUTSIDE_METRIC_THRESHOLD`に設定されている場合にこの値が返されます。可能な値については、「アラートの測定タイプ」を参照してください。
`replicaSetName`	string	レプリカセットの名前。 `"eventTypeName"`が次のいずれかに設定されている場合、MongoDB Ops Manager はこの値を返します。 `BACKUP` `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`resolved`	string	ISO8601 のタイムスタンプアラートが閉じられたときの日付と時刻形式（ UTC）。 MongoDB Ops Manager は`"status" : "CLOSED"`の場合にこの値を返します。
`status`	string	アラートの現在の状態。 MongoDB Ops Manager は次のいずれかを返すことができます。 `TRACKING` アラート条件は存在しますが、定義された通知遅延を超えて持続していません。詳細については、「リクエストクエリパラメーター」を参照してください。 `OPEN` `CLOSED` `CANCELLED`
`sourceTypeName`	string	`"eventTypeName" : "BACKUP"`の場合にバックアップされるホストのタイプ。 MongoDB Ops Manager は次のいずれかを返すことができます。 `REPLICA_SET` `SHARDED_CLUSTER` `CONFIG_SERVER`
`tags`	string 配列	このアラートに設定された識別ラベル。
`typeName`	string	非推奨のフィールド。 \|mms\|はそれを無視します。
`updated`	string	ISO8601 のタイムスタンプアラートが最後に更新されたときの UTC の日時形式。

リクエストの例

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PATCH "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-CONFIG-ID}"
6      --data '
7        {
8          "acknowledgedUntil": "2016-04-15T00:00:00-0400",
9          "acknowledgementComment": "This is normal. Please ignore."
10        }'

応答例

応答ヘッダー

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   "id" : "{ALERT-CONFIG-ID}",
3   "groupId" : "{PROJECT-ID}",
4   "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
5   "status" : "OPEN",
6   "acknowledgedUntil" : "2014-04-15T04:00:00Z",
7   "acknowledgementComment" : "This is normal. Please ignore.",
8   "acknowledgingUsername" : "someuser@example.com",
9   "created" : "2014-04-03T20:28:14Z",
10   "updated" : "2014-04-03T20:33:14Z",
11   "lastNotified" : "2014-04-03T20:33:23Z",
12   "metricName": "ASSERTS_REGULAR",
13   "currentValue" : {
14     "number" : 0.0,
15     "units" : "RAW"
16   },
17   "links" : []
18 }

戻る

アラートを 1 つ取得

Alert Configurations

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PATCH "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-CONFIG-ID}"
6	--data '
7	{
8	"acknowledgedUntil": "2016-04-15T00:00:00-0400",
9	"acknowledgementComment": "This is normal. Please ignore."
10	}'

1	{
2	"id" : "{ALERT-CONFIG-ID}",
3	"groupId" : "{PROJECT-ID}",
4	"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
5	"status" : "OPEN",
6	"acknowledgedUntil" : "2014-04-15T04:00:00Z",
7	"acknowledgementComment" : "This is normal. Please ignore.",
8	"acknowledgingUsername" : "someuser@example.com",
9	"created" : "2014-04-03T20:28:14Z",
10	"updated" : "2014-04-03T20:33:14Z",
11	"lastNotified" : "2014-04-03T20:33:23Z",
12	"metricName": "ASSERTS_REGULAR",
13	"currentValue" : {
14	"number" : 0.0,
15	"units" : "RAW"
16	},
17	"links" : []
18	}

アラートを 1 つ確認.leafygreen-ui-m0pgrr{-webkit-align-self:center;-ms-flex-item-align:center;align-self:center;padding:0 10px;visibility:hidden;}.leafygreen-ui-a30zj9{color:#889397;vertical-align:middle;margin-top:-2px;}.css-fmznk8{margin-top:-85px;position:absolute;padding-bottom:2px;}

注意