モニター ダウンタイムを使用すると、合成モニターの実行を停止する期間をスケジュールできます。 これは、計画されたメンテナンス、デプロイメント、または既知の停止時にアラートを受信したくない場合に役立ちます。1 回限りのダウンタイムまたは定期的なスケジュール (毎日、毎週、毎月) を作成できます。このチュートリアルでは、NerdGraph API を使用してモニターのダウンタイムをプログラムで管理する方法の例を示します。UIを使用して監視のダウンタイムを管理するには、「 スケジュールされたメンテナンス時間中の監視を無効にする」を参照してください。
ヒント
タイムゾーンの値については、 tz のタイムゾーン データベースを参照してください。たとえば、太平洋時間の場合はAmerica/Los_Angeles使用します。
ワンタイムモニターのダウンタイムを作る
syntheticsCreateOnceMonitorDowntimeミューテーションを使用して、1 回限りのモニター ダウンタイムを作成できます。計画的なメンテナンスや 1 度だけ発生するイベントに使用します。
入力
パラメータ | データタイプ | 必須ですか? | 説明 |
|---|---|---|---|
| 整数 | はい | ダウンタイムが作成される New Relic 。 |
| 弦 | はい | ダウンタイム期間の分かりやすい名前。 |
| 配列 | いいえ | ダウンタイムに含めるモニター のリスト。すべてのモニターに適用するには空のままにします。 |
| 弦 | はい | ダウンタイム スケジュールのタイムゾーン (例:
)。 |
| 弦 | はい | ダウンタイムが
形式で開始される時刻。 |
| 弦 | はい | ダウンタイムが
形式で終了したとき。 |
サンプルリクエスト
mutation { syntheticsCreateOnceMonitorDowntime( accountId: ACCOUNT_ID name: "MonitorDowntimeName" monitorGuids: ["OptionalMonitorEntityGuid", "OptionalMonitorEntityGuid"] timezone: "TIMEZONE" startTime: "yyyy-MM-ddTHH:mm:ss" endTime: "yyyy-MM-ddTHH:mm:ss" ) { guid accountId name monitorGuids timezone startTime endTime }}毎日の定期的なモニターダウンタイムを作成する
syntheticsCreateDailyMonitorDowntimeミューテーションを使用して、毎日繰り返されるモニターのダウンタイムを作成できます。毎日発生する定期的なメンテナンス ウィンドウにこれを使用します。
入力
パラメータ | データタイプ | 必須ですか? | 説明 |
|---|---|---|---|
| 整数 | はい | ダウンタイムが作成される New Relic 。 |
| 弦 | はい | 定期的なダウンタイムのわかりやすい名前。 |
| 配列 | いいえ | ダウンタイムに含めるモニター のリスト。 |
| 弦 | はい | ダウンタイムスケジュールのタイムゾーン。 |
| 弦 | はい | 毎日の開始時刻(
形式)。 |
| 弦 | はい | 毎日の終了時刻(
形式)。 |
| オブジェクト | いいえ | 定期的なダウンタイムを停止するタイミング。特定の日付の場合は
使用し、発生回数の場合は
使用します。 |
サンプルリクエスト
mutation { syntheticsCreateDailyMonitorDowntime( accountId: ACCOUNT_ID name: "MonitorDowntimeName" monitorGuids: [ "OptionalMonitorEntityGuid" "AnotherOptionalMonitorEntityGuid" ] timezone: "TIMEZONE" startTime: "yyyy-MM-ddTHH:mm:ss" endTime: "yyyy-MM-ddTHH:mm:ss" endRepeat: { onDate: "yyyy-MM-ddTHH:mm:ss", onRepeat: 10 } ) { guid accountId name monitorGuids timezone startTime endTime endRepeat { onDate onRepeat } }}毎週の定期的なモニター ダウンタイムを作成する
syntheticsCreateWeeklyMonitorDowntimeミューテーションを使用して、毎週定期的に実行されるモニターのダウンタイムを作成できます。特定の曜日に発生するメンテナンス ウィンドウにこれを使用します。
入力
パラメータ | データタイプ | 必須ですか? | 説明 |
|---|---|---|---|
| 整数 | はい | ダウンタイムが作成される New Relic 。 |
| 弦 | はい | 毎週のダウンタイムの分かりやすい名前。 |
| 配列 | いいえ | ダウンタイムに含めるモニター のリスト。 |
| 弦 | はい | ダウンタイムスケジュールのタイムゾーン。 |
| 弦 | はい | 週の開始時刻(
形式)。 |
| 弦 | はい | 週の終了時刻(
形式)。 |
| 配列 | はい | 曜日 (例:
、
、
)。 |
| オブジェクト | いいえ | 定期的なダウンタイムを停止するタイミング。 |
サンプルリクエスト
mutation { syntheticsCreateWeeklyMonitorDowntime( accountId: ACCOUNT_ID name: "MonitorDowntimeName" monitorGuids: [ "OptionalMonitorEntityGuid" "AnotherOptionalMonitorEntityGuid" ] timezone: "TIMEZONE" startTime: "yyyy-MM-ddTHH:mm:ss" endTime: "yyyy-MM-ddTHH:mm:ss" maintenanceDays: [MONDAY, WEDNESDAY, FRIDAY] endRepeat: { onDate: "yyyy-MM-ddTHH:mm:ss", onRepeat: 20 } ) { guid accountId name monitorGuids timezone startTime endTime maintenanceDays endRepeat { onDate onRepeat } }}毎月の定期的なモニターのダウンタイムを作成する
syntheticsCreateMonthlyMonitorDowntimeミューテーションを使用して、毎月定期的に実行されるモニターのダウンタイムを作成できます。毎月特定の日に発生するメンテナンス ウィンドウにこれを使用します。
入力
パラメータ | データタイプ | 必須ですか? | 説明 |
|---|---|---|---|
| 整数 | はい | ダウンタイムが作成される New Relic 。 |
| 弦 | はい | 毎月のダウンタイムの分かりやすい名前。 |
| 配列 | いいえ | ダウンタイムに含めるモニター のリスト。 |
| 弦 | はい | ダウンタイムスケジュールのタイムゾーン。 |
| 弦 | はい | 月次開始時刻(
形式)。 |
| 弦 | はい | 月の終了時刻(
形式)。 |
| オブジェクト | はい | 月内のいつダウンタイムが発生するかを定義します。相対的な日付(例: 最初の月曜日)には
使用し、特定の日付(例: 各月の 15 日)には
使用します。 |
| オブジェクト | いいえ | 定期的なダウンタイムを停止するタイミング。 |
サンプルリクエスト
mutation { syntheticsCreateMonthlyMonitorDowntime( accountId: ACCOUNT_ID name: "MonitorDowntimeName" monitorGuids: [ "OptionalMonitorEntityGuid" "AnotherOptionalMonitorEntityGuid" ] timezone: "TIMEZONE" startTime: "yyyy-MM-ddTHH:mm:ss" endTime: "yyyy-MM-ddTHH:mm:ss" frequency: { daysOfWeek: { weekDay: MONDAY, ordinalDayOfMonth: FIRST } daysOfMonth: [15] } endRepeat: { onDate: "yyyy-MM-ddTHH:mm:ss", onRepeat: 12 } ) { guid accountId name monitorGuids timezone startTime endTime frequency { daysOfWeek { weekDay ordinalDayOfMonth } daysOfMonth } endRepeat { onDate onRepeat } }}モニターのダウンタイムを更新する
syntheticsEditMonitorDowntimeミューテーションを使用して、既存のモニターのダウンタイムを更新できます。これにより、この単一のミューテーションを使用して、任意のダウンタイム タイプ (1 回、毎日、毎週、毎月) を変更できます。
入力
パラメータ | データタイプ | 必須ですか? | 説明 |
|---|---|---|---|
| 弦 | はい | 更新する既存のモニターのダウンタイムの 。 |
| 弦 | いいえ | ダウンタイムの名前を更新しました。 |
| 配列 | いいえ | モニター のリストを更新しました。 |
| オブジェクト | いいえ | ワンタイムダウンタイムの設定。 |
| オブジェクト | いいえ | 毎日繰り返すダウンタイムの設定。 |
| オブジェクト | いいえ | 毎週繰り返されるダウンタイムの設定。 |
| オブジェクト | いいえ | 毎月繰り返すダウンタイムの設定。 |
サンプルリクエスト
mutation { syntheticsEditMonitorDowntime( guid: "MonitorDowntimeEntityGuid" name: "MONITOR_DOWNTIME_NAME" monitorGuids: [ "OptionalMonitorEntityGuid" "AnotherOptionalMonitorEntityGuid" ] once: { timezone: "TIMEZONE" startTime: "yyyy-MM-ddTHH:mm:ss" endTime: "yyyy-MM-ddTHH:mm:ss" } daily: { timezone: "TIMEZONE" startTime: "yyyy-MM-ddTHH:mm:ss" endTime: "yyyy-MM-ddTHH:mm:ss" endRepeat: { onDate: "yyyy-MM-ddTHH:mm:ss", onRepeat: 30 } } weekly: { timezone: "TIMEZONE" startTime: "yyyy-MM-ddTHH:mm:ss" endTime: "yyyy-MM-ddTHH:mm:ss" endRepeat: { onDate: "yyyy-MM-ddTHH:mm:ss", onRepeat: 20 } maintenanceDays: [MONDAY, WEDNESDAY] } monthly: { timezone: "TIMEZONE" startTime: "yyyy-MM-ddTHH:mm:ss" endTime: "yyyy-MM-ddTHH:mm:ss" endRepeat: { onDate: "yyyy-MM-ddTHH:mm:ss", onRepeat: 12 } frequency: { daysOfWeek: { weekDay: MONDAY, ordinalDayOfMonth: FIRST } daysOfMonth: [15] } } ) { guid accountId name monitorGuids timezone startTime endTime endRepeat { onDate onRepeat } maintenanceDays frequency { daysOfWeek { weekDay ordinalDayOfMonth } daysOfMonth } }}モニターダウンタイムの削除
syntheticsDeleteMonitorDowntimeミューテーションを使用してモニターのダウンタイムを削除できます。削除されると、スケジュールされたダウンタイムは削除され、モニターは通常のスケジュールを再開します。
入力
パラメータ | データタイプ | 必須ですか? | 説明 |
|---|---|---|---|
| 弦 | はい | 削除するモニターのダウンタイムの 。 |
サンプルリクエスト
mutation { syntheticsDeleteMonitorDowntime(guid: "DOWNTIME_ENTITY_GUID") { guid }}