アラート構成の有効化と無効化

項目一覧

Resource

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

注意

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

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

Resource

PATCH /groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}

注意

このエンドポイントは、アラート構成の有効/無効状態のみを更新します。この構成以外を更新するには、「アラート構成の更新」を参照してください。

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

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

Parameter	タイプ	説明
プロジェクトID	string	このプロジェクトの一意の識別子。
ALERT-CONFIG-ID	string	このアラート構成の一意の識別子。

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

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

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

false

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

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

Parameter	タイプ	説明
enabled	ブール値	有効にするには`true`を指定します。無効にするには`false`を使用します。

応答

注意

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

名前	タイプ	説明
作成済み	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	現在のメトリクス値をしきい値と照合するときに Cloud Manager が適用した比較演算子。
metricThreshold .threshold	数値	超えた場合にアラートをトリガーする`metricThreshold.metricName`の値。
metricThreshold .units	string	`metricThreshold.threshold`の範囲を定義する容量または時間の単位。
notifications	オブジェクトの配列	アラート条件が検出されたときに Cloud Manager が通知を送信する 1 つ以上のターゲット。
notifications.[n] .apiToken	string	Slack API トークントークン。 `notifications.[n].typeName`を`SLACK`に設定すると、Cloud Manager がこの値を返します。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。 UI を通じてアラートを表示または編集します。 APIを介してサードパーティ統合設定をクエリします。
notifications.[n] .channelName	string	Slack チャンネル名。 `notifications.[n].typeName`を`SLACK`に設定すると、Cloud Manager がこの値を返します。
notifications.[n] .datadogApiKey	string	DataDog API キー。 `notifications.[n].typeName`を`DATADOG`に設定すると、Cloud Manager がこの値を返します。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。 UI を通じてアラートを表示または編集します。 APIを介してサードパーティ統合設定をクエリします。
notifications.[n] .delayMin	数値	アラート条件が検出された後最初の通知を送信するまでに待機する時間（分）。
notifications.[n] .emailAddress	string	通知を送信するメールアドレス。 `notifications.[n].typeName`を`EMAIL`に設定すると、Cloud Manager がこの値を返します。
notifications.[n] .emailEnabled	ブール値	メール通知を送信する必要があることを示すフラグ。 `notifications.[n].typeName`を`ORG` 、 `GROUP` 、または`USER`に設定すると、Cloud Manager はこの値を返します。
notifications.[n] .intervalMin	数値	解決されていない未確認アラートの連続した通知間で待機する時間（分）。
notifications.[n] .microsoftTeamsWebhookUrl	string	Microsoft Teams チャネルの受信 Webhook URL 。 `notifications.[n].typeName`を`MICROSOFT_TEAMS`に設定すると、Cloud Manager がこの値を返します。 Webhook 通知のアラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化された状態で表示されます。
notifications.[n] .mobileNumber	string	アラート通知が送信されるモバイル番号。 `notifications.[n].typeName`を`SMS`に設定すると、Cloud Manager がこの値を返します。
notifications.[n] .notificationToken	string	HipChat API トークン。 `notifications.[n].typeName`を`HIP_CHAT`に設定すると、Cloud Manager がこの値を返します。後でトークンが無効になった場合、MongoDB Atlas は`Project Owner`にメールを送信し、最終的にトークンを削除します。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。 UI を通じてアラートを表示または編集します。 APIを介してサードパーティ統合設定をクエリします。
notifications.[n] .opsGenieApiKey	string	Opsgenie Alert API キー。`notifications.[n].typeName`を`OPS_GENIE`に設定すると、Cloud Manager はこの値を返します。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。 UI を通じてアラートを表示または編集します。 APIを介してサードパーティ統合設定をクエリします。
notifications.[n] .opsGenieRegion	string	使用するAPI URLを示すリージョン。 `notifications.[n].typeName`を`OPS_GENIE`に設定すると、Cloud Manager はこの値を返します。
notifications.[n] .roles	文字列の配列	現在のプロジェクトまたは組織の Cloud Manager ロール。 `notifications.[n].typeName`を`ORG`または`GROUP`に設定すると、Cloud Manager はこの値を返します。
notifications.[n] .roomName	string	HipChat ルーム名。 Cloud Manager は、 `"notifications.typeName" : "HIP_CHAT`の場合にこの値を返します。
notifications.[n] .serviceKey	string	PagerDuty サービスキー。 `notifications.[n].typeName`を`PAGER_DUTY`に設定すると、Cloud Manager がこの値を返します。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。 UI を通じてアラートを表示または編集します。 APIを介してサードパーティ統合設定をクエリします。
notifications.[n] .smsEnabled	ブール値	テキスト通知を送信する必要があることを示すフラグ。 `notifications.[n].typeName`を`ORG` 、 `GROUP` 、または`USER`に設定すると、Cloud Manager はこの値を返します。
notifications.[n] .teamId	string	この通知を受け取るチームの固有の識別子。
notifications.[n] .teamName	string	この通知を受け取ったチームのラベル。
notifications.[n] .typeName	string	Cloud Manager がアラートの通知を送信する方法を意味します。
notifications.[n] .username	string	通知を送信する Cloud Manager ユーザーの名前。 `notifications.[n].typeName`を`USER`に設定すると、Cloud Manager がこの値を返します。
notifications.[n] .victorOpsApiKey	string	VictorOps APIキー。後でキーが無効になった場合、MongoDB Atlas は`Project Owner`にメールを送信し、最終的にキーを削除します。 `notifications.[n].typeName`を`VICTOR_OPS`に設定すると、Cloud Manager がこの値を返します。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。 UI を通じてアラートを表示または編集します。 APIを介してサードパーティ統合設定をクエリします。
notifications.[n] .victorOpsRoutingKey	string	VictorOps ルーティングキー。後でキーが無効になった場合、MongoDB Atlas は`Project Owner`にメールを送信し、最終的にキーを削除します。 `notifications.[n].typeName`を`VICTOR_OPS`に設定すると、Cloud Manager がこの値を返します。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。 UI を通じてアラートを表示または編集します。 APIを介してサードパーティ統合設定をクエリします。
notifications.[n] .webhookSecret	string	通知を受け入れ、転送する Webhook で認証するために使用される値。 `notifications.[n].typeName`を`WEBHOOK`に設定し、次のいずれかの場合に、Cloud Manager にこの値が返されます。 `notification.[n].webhookSecret` に空でないstringを設定した場合統合ページで、または統合 APIを使用してデフォルトの`webhookSecret`を設定します Webhook 通知の作成後、アラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化されます。
notifications.[n] .webhookUrl	string	この通知をトリガーする Webhook のURL 。 `notifications.[n].typeName`を`WEBHOOK`に設定し、次のいずれかの場合に、Cloud Manager にこの値が返されます。 `notification.[n].webhookURL` に空でないstringを設定した場合統合ページで、または統合 APIを使用してデフォルトの`webhookUrl`を設定します Webhook 通知の作成後、アラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化されます。
しきい値	オブジェクト	アラートをトリガーするしきい値。 Cloud Manager は、 `eventTypeName`が`OUTSIDE_METRIC_THRESHOLD`以外の値である場合、この値を返します。
threshold .operator	string	現在のメトリクス値をしきい値と照合するときに Cloud Manager が適用した比較演算子。
threshold .threshold	数値	超えた場合に Cloud Manager がアラートをトリガーする値。
threshold .units	string	`threshold.threshold`の範囲を定義する容量または時間の単位。
typeName	string	このフィールドは非推奨であり、無視されます。
Updated	string	ISO8601 のタイムスタンプこのアラート構成が最後に更新されたときの UTC の日付と時刻形式。

リクエストの例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Content-Type: application/json' \
     --include \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}" \
     --data '
       {
         "enabled" : false
       }'

応答例

応答ヘッダー

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:52:29Z",
  "enabled" : false,
  "groupId" : "{PROJECT-ID}",
  "id" : "{ALERT-CONFIG-ID}",
  "links" : [],
  "matchers" : [ {
    "fieldName" : "REPLICA_SET_NAME",
    "operator" : "EQUALS",
    "value" : "rs1"
  } ],
  "notifications" : [ {
    "delayMin" : 5,
    "emailAddress" : "sos@example.com",
    "intervalMin" : 60,
    "typeName" : "EMAIL"
  }, {
    "delayMin" : 60,
    "emailEnabled" : false,
    "intervalMin" : 120,
    "smsEnabled" : true,
    "typeName" : "GROUP"
  } ],
  "updated" : "2014-04-23T14:52:29Z"
}

戻る

アラート構成の更新

アラート構成の削除

注意