Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
Cloud Manager Administration API リソース
/
測定値とアラート
/
Alert Configurations

アラート構成のオープン アラートの取得

項目一覧

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

注意

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

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

Resource

GET /groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}/alerts

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

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

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

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

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

名前
タイプ
必要性
説明
default
pageNum
数値
任意
結果のサブセクションを返す 1 から始まる整数。
1
itemsPerPage
数値
任意
1 ページあたりに返す項目の数は最大 500 です。
100
pretty
ブール値
任意
false
envelope
ブール値
任意

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

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

結果のリストを返すエンドポイントの場合、 contentオブジェクトはエンベロープです。 Cloud Manager は、レスポンス本体にstatusフィールドを追加します。

false
backupJobsEnabledOnly
ブール値
任意
データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これをfalseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。
true

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

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前
タイプ
説明
results
配列
配列には、 results埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
links
配列
配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。
totalCount
数値
結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

results embeddedDocument

各結果は 1 つのアラート構成です。

注意

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

名前
タイプ
説明
acknowledgedUntil
string
ISO8601 のタイムスタンプ アラートが確認された日時の UTC 形式の日付と時刻形式。アラートが確認された場合は、データが入力されます。
acknowledgedUsername
string
アラートを確認したユーザーのユーザー名。 アラートが確認された場合は、データが入力されます。
acknowledgementComment
string
アラートを確認したコメント ユーザーは左にあります。 アラートが確認された場合は、データが入力されます。
alertConfigId
string
このアラートをトリガーしたアラート構成の一意の識別子。
clusterId
string
このアラートが適用されるクラスターの一意の識別子。 BACKUP 、 REPLICA_SET 、 CLUSTERアラートに入力されます。
clusterName
string
このアラートが適用されるクラスターに名前を付けます。 BACKUP 、 REPLICA_SET 、 CLUSTERアラートに入力されます。
作成済み
string
ISO8601 のタイムスタンプ アラートが開かれたときの UTC の日付と時刻形式。
currentValue
オブジェクト
アラートをトリガーしたメトリクスの現在の値。 HOST_METRICアラートに入力されます。
currentValue.number
数値
メトリクスの値。
currentValue.units
string

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

たとえば、メモリ消費を測定するメトリクスにはバイト単位が含まれ、時間を測定するメトリクスには時間単位が含まれます。 指定できる値は以下のとおりです。

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

eventTypeName
string

アラートをトリガーしたイベントの名前。

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

エージェント

オートメーション構成

バックアップ

BI Connector

請求

クラスター

Data Explorer のアクセス

ディスクバックアップ

Host

組織

プロジェクト

レプリカセット

サポートケース

チーム

user

アラートとその説明を生成するイベントの完全なリストを確認するには、「アラート タイプ 」を参照してください。

グループ ID
string
このアラートが開かれたプロジェクトの一意の識別子。
hostId
string
メトリクスが属するホストの一意の識別子。 HOST 、 HOST_METRIC 、 REPLICA_SETアラートに入力されます。
ホスト名とポート
string
アラートが適用される各ホストのホスト名とポート。 HOST 、 HOST_METRIC 、 REPLICA_SETアラートに入力されます。
id
string
アラートの一意の識別子です。
lastNotified
string
ISO8601 のタイムスタンプ このアラートの最後の通知が送信された日時の UTC 形式の日付と時刻形式。通知が送信された場合は、データが入力されます。
metricName
string

値がしきい値を超えた測定値の名前。 "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"の場合はデータが入力されます。

許容値については、このページの「アラートの測定タイプ 」を参照してください。

ReplicaSetName
string
レプリカセットの名前。 HOST 、 HOST_METRIC 、 BACKUP 、 REPLICA_SETアラートに入力されます。
解決済み
string
ISO8601 のタイムスタンプ アラートが閉じられたときの日付と時刻形式（ UTC） 。"status" : "CLOSED"の場合は入力されます。
sourceTypeName
string

BACKUPアラートの場合、バックアップされるサーバーのタイプ。 指定できる値は以下のとおりです。

  • REPLICA_SET

  • SHARDED_CLUSTER

  • CONFIG_SERVER

状態
string

アラートの現在の状態。 指定できる値は以下のとおりです。

typeName
string
このフィールドは非推奨であり、無視されます。
Updated
string
ISO8601 のタイムスタンプ アラートが最後に更新されたときの UTC の日時形式。

リクエストの例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}/alerts"

応答例

応答ヘッダー

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}

レスポンス本体

{
  "links" : [],
  "results" : [ {
    "acknowledgedUntil" : "2014-05-01T14:00:00Z",
    "alertConfigId":"{ALERT-CONFIG-ID}",
    "created" : "2014-04-22T15:57:13.562Z",
    "currentValue" : {
      "number" : 0.0,
      "units" : "RAW"
    },
    "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
    "groupId" : "{PROJECT-ID}",
    "id" : "53569159300495c7702ee3a3",
    "lastNotified" : "2014-04-22T15:57:24.126Z",
    "links" : [],
    "metricName" : "ASSERT_REGULAR",
    "status" : "OPEN",
    "updated" : "2014-04-22T20:14:11.388Z"
  }, {
    "alertConfigId":"{ALERT-CONFIG-ID}",
    "created" : "2014-04-22T19:59:10.657Z",
    "currentValue" : {
      "number" : 0.0,
      "units" : "RAW"
    },
    "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
    "groupId" : "{PROJECT-ID}",
    "id" : "5356ca0e300495c770333340",
    "lastNotified" : "2014-04-22T20:14:19.313Z",
    "links" : [],
    "metricName" : "ASSERT_REGULAR",
    "status" : "OPEN",
    "updated" : "2014-04-22T20:14:11.388Z"
  } ],
  "totalCount" : 2
}

戻る

アラート構成の削除