Confirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting Service Account or API Key must have the Project Alerts Manager, Project Monitoring Admin, Organization Owner, or Project Owner role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access.
このリソースは現在も改訂中であり、変更される可能性があります。非推奨のバージョン: v2-{2023-01-01}
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
アラートを識別するユニークな 24 桁の 16 進数の文字列。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
body
必須
1 つのアラートを確認または未確認にします。
-
このアラートが確認されるまでの日数と時間。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB ユーザーが以前にこのアラートを確認済みの場合、リソースはこのパラメータを返します。
ISO 8601 -
MongoDB Cloud ユーザーがアラートを確認するときに送信したコメント。
最大長は
200です。 -
Flag that indicates to unacknowledge a previously acknowledged alert. By default this value is set to false. If set to true, it will override the
acknowledgedUntilparameter.
PATCH /API/Atlas/v2/groups/{groupId}/alerts/{alertId}
Atlas CLI
atlas api alerts acknowledgeAlert --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20240530001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.AcknowledgeGroupAlertApiParams{}
sdkResp, httpResp, err := client.AlertsApi.
AcknowledgeGroupAlertWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-05-30+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-05-30+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \
-d '{ <Payload> }'
リクエスト例
{
"acknowledgedUntil": "2026-05-04T09:42:00Z",
"acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
"unacknowledgeAlert": true
}
応答の例（200）
App Services アラート
{
"acknowledgedUntil": "2026-05-04T09:42:00Z",
"acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
"acknowledgingUsername": "hello@example.com",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"created": "2026-05-04T09:42:00Z",
"eventTypeName": "DEPLOYMENT_FAILURE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"lastNotified": "2026-05-04T09:42:00Z",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"resolved": "2026-05-04T09:42:00Z",
"status": "OPEN",
"updated": "2026-05-04T09:42:00Z"
}{
"acknowledgedUntil": "2026-05-04T09:42:00Z",
"acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
"acknowledgingUsername": "hello@example.com",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"clusterName": "cluster1",
"created": "2026-05-04T09:42:00Z",
"eventTypeName": "CLUSTER_MONGOS_IS_MISSING",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"lastNotified": "2026-05-04T09:42:00Z",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"resolved": "2026-05-04T09:42:00Z",
"status": "OPEN",
"updated": "2026-05-04T09:42:00Z"
}{
"acknowledgedUntil": "2026-05-04T09:42:00Z",
"acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
"acknowledgingUsername": "hello@example.com",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"clusterName": "cluster1",
"created": "2026-05-04T09:42:00Z",
"eventTypeName": "HOST_DOWN",
"groupId": "32b6e34b3d91647abb20e7b8",
"hostnameAndPort": "cloud-test.mongodb.com:27017",
"id": "32b6e34b3d91647abb20e7b8",
"lastNotified": "2026-05-04T09:42:00Z",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"replicaSetName": "event-replica-set",
"resolved": "2026-05-04T09:42:00Z",
"status": "OPEN",
"updated": "2026-05-04T09:42:00Z"
}{
"acknowledgedUntil": "2026-05-04T09:42:00Z",
"acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
"acknowledgingUsername": "hello@example.com",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"clusterName": "cluster1",
"created": "2026-05-04T09:42:00Z",
"currentValue": {
"number": 42.0,
"units": "bits"
},
"eventTypeName": "OUTSIDE_METRIC_THRESHOLD",
"groupId": "32b6e34b3d91647abb20e7b8",
"hostnameAndPort": "cloud-test.mongodb.com:27017",
"id": "32b6e34b3d91647abb20e7b8",
"lastNotified": "2026-05-04T09:42:00Z",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"metricName": "ASSERT_USER",
"orgId": "32b6e34b3d91647abb20e7b8",
"replicaSetName": "event-replica-set",
"resolved": "2026-05-04T09:42:00Z",
"status": "OPEN",
"updated": "2026-05-04T09:42:00Z"
}{
"acknowledgedUntil": "2026-05-04T09:42:00Z",
"acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
"acknowledgingUsername": "hello@example.com",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"clusterName": "cluster1",
"created": "2026-05-04T09:42:00Z",
"eventTypeName": "NO_PRIMARY",
"groupId": "32b6e34b3d91647abb20e7b8",
"hostnameAndPort": "cloud-test.mongodb.com:27017",
"id": "32b6e34b3d91647abb20e7b8",
"lastNotified": "2026-05-04T09:42:00Z",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"nonRunningHostIds": [
"32b6e34b3d91647abb20e7b8"
],
"orgId": "32b6e34b3d91647abb20e7b8",
"parentClusterId": "32b6e34b3d91647abb20e7b8",
"replicaSetName": "event-replica-set",
"resolved": "2026-05-04T09:42:00Z",
"status": "OPEN",
"updated": "2026-05-04T09:42:00Z"
}{
"acknowledgedUntil": "2026-05-04T09:42:00Z",
"acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
"acknowledgingUsername": "hello@example.com",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"created": "2026-05-04T09:42:00Z",
"eventTypeName": "HOST_DOWN",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"instanceName": "foobar",
"lastNotified": "2026-05-04T09:42:00Z",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"processorErrorMsg": "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)",
"processorName": "foobar",
"processorState": "STARTED",
"resolved": "2026-05-04T09:42:00Z",
"status": "OPEN",
"updated": "2026-05-04T09:42:00Z"
}{
"acknowledgedUntil": "2026-05-04T09:42:00Z",
"acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
"acknowledgingUsername": "hello@example.com",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"created": "2026-05-04T09:42:00Z",
"eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"lastNotified": "2026-05-04T09:42:00Z",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"resolved": "2026-05-04T09:42:00Z",
"status": "OPEN",
"updated": "2026-05-04T09:42:00Z"
}
応答の例（400）
{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}
応答の例（401）
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
応答の例（403）
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
応答の例（404）
{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
応答の例（500）
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}