Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

アラート構成の作成

項目一覧

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

注意

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

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

POST /groups/{PROJECT-ID}/alertConfigs

すべてのリクエスト パス パラメータは必須 です

Parameter
タイプ
説明
プロジェクトID
string
このプロジェクトの一意の識別子。

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

名前
タイプ
必要性
説明
default
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

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

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

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

名前
説明
status
HTTPレスポンス コード
content
期待される応答本体
false

注意

アラート構成はさまざまです。 アラート構成には、これらの要素のサブセットのみを含めることができます。

名前
タイプ
説明
enabled
ブール値
省略した場合、構成は無効になります。
eventTypeName
Required.
string

アラートをトリガーするイベントの種類。

値には、次のものが含まれます。

エージェント

オートメーション構成

バックアップ

BI Connector

クラスター

Data Explorer のアクセス

Host

組織

プロジェクト

レプリカセット

チーム

user

アラートとその説明を生成するイベントの完全なリストを確認するには、「アラート タイプ 」を参照してください。 MongoDB Ops Managerの監査ログに含まれるイベントの完全なリストについては、「監査イベント 」を参照してください。

Atlas.fieldName
string

一致するターゲット オブジェクト内のフィールドの名前。

  • ホスト アラートは、次のフィールドをサポートします。

    • HOSTNAME

    • PORT

    • HOSTNAME_AND_PORT

    • REPLICA_SET_NAME

    • TYPE_NAME

  • レプリカセット アラートは次のフィールドをサポートします。

    • REPLICA_SET_NAME

    • SHARD_NAME

    • CLUSTER_NAME

  • シャーディングされたクラスター アラートは、次のフィールドをサポートします。

    • CLUSTER_NAME

    • SHARD_NAME

他のタイプのアラートはすべてマッチャーをサポートしていません。

matchers.operator
string

フィールドの値をテストする演算子。 指定できる値は以下のとおりです。

  • EQUALS

  • NOT_EQUALS

  • CONTAINS

  • NOT_CONTAINS

  • STARTS_WITH

  • ENDS_WITH

  • REGEX

matchers.value
string

指定された演算子でテストする値。

matchers.fieldNameTYPE_NAMEに設定されている場合は、次の値を照合できます。

  • PRIMARY

  • SECONDARY

  • STANDALONE

  • CONFIG

  • MONGOS

マッチャー
オブジェクト配列

このアラート構成に対してオブジェクトを照合するときに適用するルール。 これらのすべてのルールに一致するエンティティのみがアラート条件についてチェックされます。

eventTypeNameがホスト、レプリカセット、またはシャーディングされたクラスターのイベントを指定している場合にのみ、 matchers配列を使用してフィルタリングできます。

metricThreshold.metricName
string
確認するメトリクスの名前。 alertsリソースのmetricNameフィールドと同じ値をサポートします。
metricThreshold.mode
string
このメトリクスの平均を計算するには、 AVERAGEに設定します。
metricThreshold.operator
string

現在のメトリクス値をしきい値と照合するときに適用する演算子。 指定できる値は以下のとおりです。

  • GREATER_THAN

  • LESS_THAN

metricThreshold.threshold
数値
アラートがトリガーされる範囲外のしきい値。
metricThreshold.units
string

しきい値の単位。 メトリクスの型によって異なります。

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

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

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

metricThreshold
オブジェクト
アラートがトリガーされるしきい値。 "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"の場合は必須です。
authentication.apiToken
string

Slack API トークンまたは Bot トークン。 "notifications.typeName" : "SLACK"の場合は必須です。 後でトークンが無効になった場合、 MongoDB Ops Managerはプロジェクト所有者にメールを送信し、最終的にトークンを削除します。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

refresh.channelName
string
Slack チャンネル名。 "notifications.typeName" : "SLACK"の場合は必須です。
authentication.datadogApiKey
string

DataDog API キー。 DataDog ダッシュボードで確認できます。 "notifications.typeName" : "DATADOG"の場合は必須です。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

authentication.deployMin
数値
アラート条件が検出された後最初の通知を送信するまでに待機する時間(分)。
authentication.emailAddress
string
通知を送信するメールアドレス。 "notifications.typeName" : "EMAIL"の場合は必須です。
authentication.emailEnabled
ブール値

メール通知を送信するかどうかを決定します。 次の場合は必須です。

  • "notifications.typeName" : "GROUP"

  • "notifications.typeName" : "USER"

refresh.IntervalMin
数値
解決されていない未確認アラートの連続した通知間で待機する時間(分)。
refresh.webhookSecret
string

通知を受け入れ、転送する Webhook で認証するために使用される値。 シークレットを明示的に宣言できるのは、次の両方を持つリクエストでのみです。

  • A notifications.typeName WEBHOOK

  • 明示的に宣言された notifications.webhookURL

統合ページまたは統合 APIを使用してのみ、デフォルトのwebhookURLwebhookSecretを構成できます。

webhookSecret webhookURLを明示的に宣言するには、このフィールドを省略します。

Webhook 通知の作成後、アラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化されます。

refresh.webhookUrl
string

この通知をトリガーする Webhook のURLwebhookUrlを明示的に宣言しない場合、リクエストでは統合ページまたは統合 APIで設定されたデフォルトのwebhookUrlが使用されます。

Webhook 通知の作成後、アラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化されます。

authentication.MicrosoftTeamsWebhookUrl
string

Microsoft Teams チャネルの受信 Webhook URL 。 "notifications.typeName" : "MICROSOFT_TEAMS"の場合は必須です。

Webhook 通知のアラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化された状態で表示されます。

refresh. mobileNumber
string
SMS メッセージの送信先の携帯電話番号。 "notifications.typeName" : "SMS"の場合は必須です。
transformation.notificationToken
string

HipChat API トークン。 "notifications.typeName" : "HIP_CHAT"の場合は必須です。 後でトークンが無効になった場合、 MongoDB Ops Managerはプロジェクト所有者にメールを送信し、最終的にトークンを削除します。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

refresh.role
string
現在のプロジェクトでの MongoDB Ops Manager ロール。 "notifications.typeName" : "GROUP"の場合は必須です。
refresh.roomName
string
HipChat ルーム名。 "notifications.typeName" : "HIP_CHAT"の場合は必須です。
authentication.serviceKey
string

PagerDuty 統合キー。 "notifications.typeName" : "PAGER_DUTY"の場合は必須です。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

authentication.smsEnabled
ブール値

SMS 通知を送信する必要があることを示すフラグ。 次の場合は必須です。

  • "notifications.typeName" : "GROUP"

  • "notifications.typeName" : "USER"

refresh. teamId
string
チームの一意の識別子。
refresh.typeName
string

アラート通知のタイプ。 指定できる値は以下のとおりです。

  • DATADOG

  • EMAIL

  • GROUP (プロジェクト)

  • HIPCHAT

  • ORG

  • PAGER_DUTY

  • SLACK

  • SMSTwilio 統合を構成する必要があります)

  • USER

  • WEBHOOK

refresh.username
string
通知を送信する MongoDB Ops Manager ユーザーの名前。 アラート構成を所有するプロジェクト内のユーザーを指定します。 "notifications.typeName" : "USER"の場合は必須です。
notifications
Required
オブジェクト配列
アラート条件が検出されたときに送信する通知。
しきい値. 演算子
string

現在のメトリクス値をしきい値と照合するときに適用する演算子。

  • GREATER_THAN

  • LESS_THAN

mapping.threshold
数値
アラートがトリガーされる範囲外のしきい値。
しきい値
オブジェクト

アラートがトリガーされるしきい値。 次の場合は必須です。

  • "eventTypeName" : "TOO_FEW_HEALTHY_MEMBERS"

  • "eventTypeName" : TOO_MANY_UNHEALTHY_MEMBERS

応答にはアラート構成の詳細が含まれます。

注意

アラート構成はさまざまです。 アラート構成には、これらの要素のサブセットのみを含めることができます。

名前
タイプ
説明
作成済み
string
ISO8601 のタイムスタンプ このアラート構成が作成されたときの UTC の日付と時刻形式。
enabled
ブール値
このアラート構成が有効になっていることを示すフラグ。
eventTypeName
string
アラートをトリガーするイベントのタイプ。
グループ ID
string
このアラート構成を所有するプロジェクトの一意の識別子。
id
string
アラート構成の一意の識別子です。
Links
オブジェクトの配列

サブリソースや関連リソースへの 1 つ以上のリンク。 URL 間の関係タイプについては、 Web リンク仕様 で説明されています。

マッチャー
オブジェクトの配列
このアラート構成に対してオブジェクトを照合するときに適用するルール。
matchers
.[n].fieldName
string
この構成で一致させたターゲット オブジェクト内のフィールドの名前。
matchers
.[n].operator
string
現在のメトリクス値をmatcher.[n].valueと照合するときに適用する比較演算子。
matchers
.[n].value
string
matchers.[n].operatorを使用して一致するかそれを超える値。
metricThreshold
オブジェクト
アラートをトリガーする比較の値と平均。
metricThreshold
.metricName
string
確認するメトリクスの名前。 alertsリソースのmetricNameフィールドと同じ値をサポートします。
metricThreshold
.mode
string
このメトリクスの平均値。
metricThreshold
.operator
string
現在のメトリクス値をしきい値と照合するときに MongoDB Ops Manager が適用した比較演算子。
metricThreshold
.threshold
数値
超えた場合にアラートをトリガーするmetricThreshold.metricNameの値。
metricThreshold
.units
string
metricThreshold.thresholdの範囲を定義する容量または時間の単位。
notifications
オブジェクトの配列
アラート条件が検出されたときに MongoDB Ops Manager が通知を送信する 1 つ以上のターゲット。
notifications.[n]
.apiToken
string

Slack API トークン トークン。 notifications.[n].typeNameSLACKに設定すると、MongoDB Ops Manager はこの値を返します。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

notifications.[n]
.channelName
string
Slack チャンネル名。 notifications.[n].typeNameSLACKに設定すると、MongoDB Ops Manager はこの値を返します。
notifications.[n]
.datadogApiKey
string

DataDog API キー。 notifications.[n].typeNameDATADOGに設定すると、MongoDB Ops Manager はこの値を返します。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

notifications.[n]
.delayMin
数値
アラート条件が検出された後最初の通知を送信するまでに待機する時間(分)。
notifications.[n]
.emailAddress
string
通知を送信するメールアドレス。 notifications.[n].typeNameEMAILに設定すると、MongoDB Ops Manager はこの値を返します。
notifications.[n]
.emailEnabled
ブール値
メール通知を送信する必要があることを示すフラグ。 notifications.[n].typeNameORGGROUP 、またはUSERに設定すると、MongoDB Ops Manager はこの値を返します。
notifications.[n]
.intervalMin
数値
解決されていない未確認アラートの連続した通知間で待機する時間(分)。
notifications.[n]
.microsoftTeamsWebhookUrl
string

Microsoft Teams チャネルの受信 Webhook URL 。 notifications.[n].typeNameMICROSOFT_TEAMSに設定すると、MongoDB Ops Manager はこの値を返します。

Webhook 通知のアラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化された状態で表示されます。

notifications.[n]
.mobileNumber
string
アラート通知が送信されるモバイル番号。 notifications.[n].typeNameSMSに設定すると、MongoDB Ops Manager はこの値を返します。
notifications.[n]
.notificationToken
string

HipChat API トークン。 notifications.[n].typeNameHIP_CHATに設定すると、MongoDB Ops Manager はこの値を返します。

後でトークンが無効になった場合、MongoDB Atlas はProject Ownerにメールを送信し、最終的にトークンを削除します。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

notifications.[n]
.opsGenieApiKey
string

Opsgenie Alert API キー。notifications.[n].typeNameOPS_GENIEに設定すると、MongoDB Ops Manager はこの値を返します。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

notifications.[n]
.opsGenieRegion
string
使用するAPI URLを示すリージョン。 notifications.[n].typeNameOPS_GENIEに設定すると、MongoDB Ops Manager はこの値を返します。
notifications.[n]
.roles
文字列の配列
現在のプロジェクトまたは組織の MongoDB Ops Manager ロール。 notifications.[n].typeNameORGまたはGROUPに設定すると、MongoDB Ops Manager はこの値を返します。
notifications.[n]
.roomName
string
HipChat ルーム名。 MongoDB Ops Manager は"notifications.typeName" : "HIP_CHATの場合にこの値を返します。
notifications.[n]
.serviceKey
string

PagerDuty サービス キー。 notifications.[n].typeNamePAGER_DUTYに設定すると、MongoDB Ops Manager はこの値を返します。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

notifications.[n]
.smsEnabled
ブール値
テキスト通知を送信する必要があることを示すフラグ。 notifications.[n].typeNameORGGROUP 、またはUSERに設定すると、MongoDB Ops Manager はこの値を返します。
notifications.[n]
.teamId
string
この通知を受け取るチームの固有の識別子。
notifications.[n]
.teamName
string
この通知を受け取ったチームのラベル。
notifications.[n]
.typeName
string
MongoDB Ops Manager がアラートの通知を送信する方法を意味します。
notifications.[n]
.username
string
通知を送信する MongoDB Ops Manager ユーザーの名前。 notifications.[n].typeNameUSERに設定すると、MongoDB Ops Manager はこの値を返します。
notifications.[n]
.victorOpsApiKey
string

VictorOps APIキー。

後でキーが無効になった場合、MongoDB Atlas はProject Ownerにメールを送信し、最終的にキーを削除します。

notifications.[n].typeNameVICTOR_OPSに設定すると、MongoDB Ops Manager はこの値を返します。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

notifications.[n]
.victorOpsRoutingKey
string

VictorOps ルーティングキー。

後でキーが無効になった場合、MongoDB Atlas はProject Ownerにメールを送信し、最終的にキーを削除します。

notifications.[n].typeNameVICTOR_OPSに設定すると、MongoDB Ops Manager はこの値を返します。

notifications.[n]
.webhookSecret
string

通知を受け入れ、転送する Webhook で認証するために使用される値。

notifications.[n].typeNameWEBHOOKに設定し、次のいずれかを実行すると、MongoDB Ops Manager はこの値を返します。

  • notification.[n].webhookSecret に空でないstringを設定した場合

  • 統合ページで、または統合 APIを使用してデフォルトのwebhookSecretを設定します

Webhook 通知の作成後、アラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化されます。

notifications.[n]
.webhookUrl
string

この通知をトリガーする Webhook のURL

notifications.[n].typeNameWEBHOOKに設定し、次のいずれかを実行すると、MongoDB Ops Manager はこの値を返します。

  • notification.[n].webhookURL に空でないstringを設定した場合

  • 統合ページで、または統合 APIを使用してデフォルトのwebhookUrlを設定します

Webhook 通知の作成後、アラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化されます。

しきい値
オブジェクト
アラートをトリガーするしきい値。 MongoDB Ops Manager は、 eventTypeNameOUTSIDE_METRIC_THRESHOLD以外の値である場合、この値を返します。
threshold
.operator
string
現在のメトリクス値をしきい値と照合するときに MongoDB Ops Manager が適用した比較演算子。
threshold
.threshold
数値
超えた場合に MongoDB Ops Manager がアラートをトリガーする値。
threshold
.units
string
threshold.thresholdの範囲を定義する容量または時間の単位。
typeName
string
このフィールドは非推奨であり、無視されます。
Updated
string
ISO8601 のタイムスタンプ このアラート構成が最後に更新されたときの UTC の日付と時刻形式。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--include \
--request POST "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs" \
--data '
{
"eventTypeName" : "RESYNC_REQUIRED",
"enabled" : true,
"notifications" : [ {
"typeName" : "GROUP",
"intervalMin" : 5,
"delayMin" : 0,
"smsEnabled" : false,
"emailEnabled" : 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}
{
"created" : "2014-04-23T14:29:18Z",
"enabled" : true,
"groupId" : "{PROJECT-ID}",
"id" : "{ALERT-CONFIG-ID}",
"links" : [],
"matchers" : [ ],
"notifications" : [ {
"delayMin" : 0,
"emailEnabled" : true,
"intervalMin" : 5,
"smsEnabled" : false,
"typeName" : "GROUP"
} ],
"updated" : "2014-04-23T14:29:18Z"
}

戻る

プロジェクトのすべてのアラート構成を取得する