URL をリクエストする

get

https://api.dotcom-monitor.com/config_api_v1/デバイス/ {device_id}

デバイスの設定を ID で取得します。

パスパラメータ

種類 必須 形容
device_id

true

監視デバイスの一意の ID。 プラットフォーム内のデバイス ID のリストを要求するには 、API: プラットフォーム別のデバイスリストの取得を参照してください。

ドットコムモニターアカウント内からデバイスIDを表示するには、デバイスマネージャのリストでターゲットデバイスを開いて編集します。 ブラウザのアドレスバーには、次のようなものが表示されます。

https://user.dotcom-monitor.com/ClientID/DeviceEdit?pid=dc7f4ff2ca944dekjh1078b96707002&deviceId=63698&taskId=132834

デバイス ID=63698はデバイス ID です。

成功の応答

サーバービュー/ブラウザービューデバイス JSON オブジェクトの例
{
    "Avoid_Simultaneous_Checks": false,
    "Alert_Silence_Min": 94,
    "False_Positive_Check": false,
    "Locations": [
        1,
        4,
        6,
        14,
        15,
        17,
        19,
        23,
        43,
        71,
        73
    ],
    "Tags": null,
    "ContextParams": [],
    "Send_Uptime_Alert": false,
    "Status_Description": "POSTPONED",
    "Postpone": true,
    "Owner_Device_Id": 0,
    "Frequency": 10800,
    "Filter_Id": 7791,
    "Scheduler_Id": 0,
    "Notifications": {
        "E_Mail_Flag": false,
        "E_Mail_Address": null,
        "E_Mail_TimeInterval_Min": 0,
        "WL_Device_Flag": false,
        "WL_Device_Email_Address": null,
        "WL_Device_TimeInterval_Min": 0,
        "Pager_Flag": false,
        "Pager_Area_Code": null,
        "Pager_Phone": null,
        "Pager_Num_Code": null,
        "Pager_TimeInterval_Min": 0,
        "Phone_Flag": false,
        "Phone_Area_Code": null,
        "Phone_Phone": null,
        "Phone_TimeInterval_Min": 0,
        "SMS_Flag": false,
        "SMS_Phone": null,
        "SMS_TimeInterval_Min": 0,
        "Script_Flag": false,
        "Script_Batch_File_Name": null,
        "Script_TimeInterval_Min": 0,
        "SNMP_TimeInterval_Min": 0,
        "Teams_TimeInterval_Min": 0,
        "Slack_TimeInterval_Min": 0,
        "AlertOps_TimeInterval_Min": 0,
        "PagerDuty_TimeInterval_Min": 0,
        "Notification_Groups": []
    },
    "Id": 47432,
    "Number_Of_Tasks": 1,
    "WaitingForApproval": false,
    "Platform_Id": 1,
    "Package_Id": 52,
    "Name": "FullPageDomain.cs"
}

フィールド説明

これらのフィールドを使用して、API リクエスト内のデバイスに関する情報を指定します。

種類

形容

Avoid_Simultaneous_Checks

ブーリアン

複数の監視場所からの同時チェックが許可されているかどうかを示します。 サーバービュー デバイスでのみ使用できます。

例:
"Avoid_Simultaneous_Checks": true

Alert_Silence_Min

int32

読み取り専用。 すべてのアラートが無効になっている時間を分単位で定義します。 アラートを無効にするには、「API: デバイスまたは APIのアラートを無効にする: 複数のデバイスのアラートを無効にする」を使用します。

例:
"Alert_Silence_Min": 46

False_Positive_Check

ブーリアン

エラーが検出されると、一連のチェックを実行して、誤ったアラートではないことを確認します。 これらのチェックは、デバイスのエラーの種類とタスクの数によっては、時間がかかる場合があります。 これにより、ダウンタイムの警告が少し遅れる可能性があります。 即時のダウンタイムアラートを確認するために、誤検知チェック (“true” 状態) を無効にできますが、一部の “偽” アラートが発生する可能性があります。 「誤検知チェック」を無効にしないことをお勧めします。

例:
"False_Positive_Check": false

場所

int32 の配列

指定したデバイスに割り当てられたロケーション ID を含む配列。 要求には、少なくとも 1 つの場所を指定する必要があります。

例:
"Locations": [1, 2, 4, 5, 8]

タグ

文字列の配列

指定したデバイスに割り当てられたタグの名前を含む配列。

例:
"Tags": ["green", "red", "black"]

Send_Uptime_Alert

ブーリアン

このオプションを有効にすると、検出されたすべてのエラーが解決されたときにアラートが表示されます。

例:
"Send_Uptime_Alert": false

Status_Description

読み取り専用。 現在のデバイスの状態を記述します。

例:
"Status_Description": "POSTPONED"

延期する

ブーリアン

デバイスを延期することで、一時停止時にモニタリングを設定できます。

例:
"Postpone": true,

Owner_Device_Id

int32

このフィールドには、所有者デバイス ID が反映されます。

例:
"Owner_Device_Id": 8534

周波数

int32

このフィールドは、監視頻度を秒単位で反映します。

例:
"Frequency": 10800

Filter_Id

int32

このフィールドには、デバイスに割り当てられたフィルター ID が反映されます。

例:
"Filter_Id": 853

Scheduler_Id

int32

このフィールドには、デバイスに割り当てられたスケジューラ ID が反映されます。

例:
"Scheduler_Id": 534

通知

オブジェクトの配列

警告の設定の一覧を示します

#1例:
"Notifications":
{
"E_Mail_Flag": true,
"E_Mail_Address": "demo@at.com",
"E_Mail_TimeInterval_Min": 10
}
#2例:
"Notifications":
{
"Notification_Groups":
[{
"Id": 608,
"Time_Shift_Min": 10
}]
}

E_Mail_Flag

ブーリアン

電子メール通知を送信する場合に定義します。

例:
"E_Mail_Flag": false

E_Mail_Address

電子メールアラートの電子メール アドレスを指定します。

例:
"E_Mail_Address": "demo@company.com"

E_Mail_TimeInterval_Min

int32

このフィールドでは、電子メールアラートの間隔を分単位で設定できます

例:
"E_Mail_TimeInterval_Min": 15

WL_Device_Flag

ブーリアン

ワイヤレス デバイスのアラートを送信する場合に定義します。

例:
"WL_Device_Flag": false

WL_Device_Email_Address

このフィールドは、電話やポケットベルなどの通知用のワイヤレス デバイスを指定します。

例:
"WL_Device_Email_Address": "wireless@company.com"

WL_Device_TimeInterval_Min

int32

このフィールドでは、ワイヤレス デバイスのアラート間隔を分単位で設定できます。

例:
"WL_Device_TimeInterval_Min": 13

Pager_Flag

ブーリアン

ポケットベルの警告を送信する場合に定義します。

例:
"Pager_Flag": true

Pager_Area_Code

ポケットベルの市外局番。

例:
"Pager_Area_Code": "917"

Pager_Phone

ポケットベル電話。

例:
"Pager_Phone": "3214564"

Pager_Num_Code

数値ポケットベルのコード。

例:
"Pager_Num_Code": "225"

Pager_TimeInterval_Min

int32

このフィールドでは、ポケットベルの通知間隔を分単位で設定できます。

例:
"Pager_TimeInterval_Min": 5

Phone_Flag

ブーリアン

電話の警告を行うかどうかを定義します。 電話でアラートを受信するには、値を「true」に設定し、電話番号を指定します。 電話アラートは対話型で、アラートを受信すると、その後のアラートを延期できます。

例:
"Phone_Flag": true

Phone_Area_Code

国コードが “1” の場合 (たとえば、米国、カナダ、カリブ海諸国)、市外局番と番号 (952-5134349 など) を入力します。 その他の国コードについては、プレフィックス”011″、国コード、電話番号(011-44-95-2244392 など)を使用します。

例:
"Phone_Area_Cde": "952"

Phone_Phone

電話番号。

例:
"Phone_Phone": "5134349"

Phone_TimeInterval_Min

int32

このフィールドでは、電話の間隔を設定できます。

例:
"Phone_TimeInterval_Min": 2

SMS_Flag

ブーリアン

SMS アラートを送信する場合に定義します。

例:
"SMS_Flag": false

SMS_Phone

国番号を含む電話番号 (たとえば、 US – 1 952 513 4349;英国449524 4392)。 番号に「011」などの国際ダイヤルの接頭番号を使用しないでください。

例:
"SMS_Phone": "19525134349"

SMS_TimeInterval_Min

int32

このフィールドでは、SMS アラートの間隔を設定できます。

例:
"SMS_TimeInterval_Min": 0

Script_Flag

ブーリアン

このフィールドは、カスタムアラートスクリプトによってアラートを実行するかどうか定義します。

例:
"Script_Flag": false

Script_Batch_File_Name

カスタム スクリプト ファイル名。 スクリプトは、サーバーに既にインストールされている必要があります。

例:
"Script_Batch_File_Name":"alerting.cs"

Script_TimeInterval_Min

int32

このフィールドでは、カスタム スクリプトアラートの間隔を設定できます。

例:
"Script_TimeInterval_Min":5

Notification_Groups

オブジェクトの配列

ID と時間シフトを持つアクティブなアラート グループを示します。 [タイム シフト] は、エラー状態の継続時間に基づいてアラートエスカレーション プロセスを作成できるオプションです。 アラートのエスカレーション時間間隔は、即時から 3 時間の範囲です。

例:
"Notification_Groups":
[{
"Id": 608,
"Time_Shift_Min": 10
}, {
"Id": 609,
"Time_Shift_Min": 20
}]

Number_Of_Tasks

int32

読み取り専用フィールド。指定されたデバイスのタスク数を表示します。

例:
"Number_Of_Tasks": 15

身分証明書

int32

読み取り専用フィールド。 一意のデバイス ID。 新しいデバイスの作成時に自動的に割り当てられます。 要求でデバイスを指定するために使用します。

例:
"Id": 8533

Platform_Id

int32

読み取り専用フィールド。 各プラットフォーム (サーバービュー、ユーザービューなど) は、独自の ID を持っています。 プラットフォームの ID を取得する方法については、 こちらをご 覧ください

例:
"Platform_Id": 1

名前

デバイスの名前。

例:
"Name": "new name"