طلب عنوان URL

احصل على

https://api.dotcom-monitor.com/config_api_v1/جهاز/{device_id}

احصل على إعداد الجهاز من خلال معرفه.

معلمات المسار

ميدان نوع مطلوب وصف
device_id

خيط

صحيح

 المعرف الفريد لجهاز المراقبة. لطلب قائمة بمعرفات الأجهزة داخل النظام الأساسي، راجع واجهة برمجة التطبيقات: الحصول على قائمة الأجهزة حسب النظام الأساسي.

للاطلاع على معرف جهاز من داخل حساب dotcom-monitor الخاص بك، افتح الجهاز المستهدف في قائمة “إدارة الأجهزة” لتحريره. في شريط عناوين المتصفح، سترى شيئا مثل:

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

معرف الجهاز = 63698 هو معرف الجهاز.

الاستجابة للنجاح

مثال على ServerView/BrowserView كائن 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"
}

وصف الحقول

استخدم هذه الحقول لتحديد معلومات حول جهاز في طلبات واجهة برمجة التطبيقات.

ميدان

نوع

 وصف

Avoid_Simultaneous_Checks

منطقيه

 يشير إلى ما إذا كان يسمح بالفحص المتزامن من مواقع المراقبة المتعددة. متوفر فقط لأجهزة ServerView.

مثل:
"Avoid_Simultaneous_Checks": true

Alert_Silence_Min

إنت32

 للقراءة فقط. يحدد الفترة الزمنية بالدقائق عند تعطيل جميع التنبيهات. لتعطيل التنبيهات، استخدم واجهة برمجة التطبيقات: تعطيل التنبيهات للجهاز أو واجهة برمجة التطبيقات: تعطيل التنبيهات لعدة أجهزة.

مثل:
"Alert_Silence_Min": 46

False_Positive_Check

منطقيه

 عندما يتم اكتشاف الخطأ ، نقوم بإجراء سلسلة من الفحوصات للتأكد من أنه ليس تنبيها خاطئا. قد تستغرق عمليات التحقق هذه بعض الوقت ، اعتمادا على نوع الخطأ وعدد المهام في الجهاز. قد يتسبب ذلك في بعض التأخير في تنبيه وقت التوقف. يمكنك تعطيل التحقق الإيجابي الخاطئ (الحالة “الحقيقية”) لضمان التنبيه الفوري لوقت التوقف عن العمل، ولكنه قد يؤدي إلى بعض التنبيهات “الخاطئة”. نوصي بعدم تعطيل “فحص إيجابي خاطئ”.

مثل:
"False_Positive_Check": false

مواقع

مجموعة من int32

 صفيف يحتوي على معرفات الموقع المعينة لجهاز معين. يجب تحديد موقع واحد على الأقل في الطلبات.

مثل:
"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

إنت32

 يعكس هذا الحقل رقم تعريف جهاز المالك.

مثل:
"Owner_Device_Id": 8534

تردد

إنت32

 يعكس هذا الحقل تردد المراقبة في ثوان.

مثل:
"Frequency": 10800

Filter_Id

إنت32

 يعكس هذا الحقل معرف الفلتر المعين لجهاز.

مثل:
"Filter_Id": 853

Scheduler_Id

إنت32

 يعكس هذا الحقل معرف المجدول المعين لجهاز.

مثل:
"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

إنت32

 يسمح هذا الحقل بتعيين فاصل زمني بين تنبيهات البريد الإلكتروني في دقائق

مثل:
"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

إنت32

 يسمح هذا الحقل بتعيين فاصل زمني بين تنبيهات الجهاز اللاسلكي في دقائق.

مثل:
"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

إنت32

 يسمح هذا الحقل بتعيين فاصل زمني بين تنبيهات جهاز النداء في دقائق.

مثل:
"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

إنت32

 يسمح هذا الحقل بتعيين فاصل زمني بين المكالمات الهاتفية.

مثل:
"Phone_TimeInterval_Min": 2

SMS_Flag

منطقيه

 يحدد ما إذا كان سيتم إرسال تنبيهات الرسائل القصيرة.

مثل:
"SMS_Flag": false

SMS_Phone

 خيط رقم هاتف يحتوي على رمز بلد (على سبيل المثال: US – 1 952 513 4349; المملكة المتحدة 449524 4392). لا تستخدم بادئة طلب دولي، مثل “011” في الرقم.

مثل:
"SMS_Phone": "19525134349"

SMS_TimeInterval_Min

إنت32

 يسمح هذا الحقل بتعيين فاصل زمني بين تنبيهات الرسائل القصيرة.

مثل:
"SMS_TimeInterval_Min": 0

Script_Flag

منطقيه

 يحدد هذا الحقل ما إذا كان سيتم تنفيذ التنبيه بواسطة برامج نصية مخصصة للتنبيه.

مثل:
"Script_Flag": false

Script_Batch_File_Name

خيط

 اسم ملف البرنامج النصي المخصص. يجب تثبيت البرنامج النصي بالفعل على الخادم.

مثل:
"Script_Batch_File_Name":"alerting.cs"

Script_TimeInterval_Min

إنت32

 يسمح هذا الحقل بتعيين فاصل زمني بين تنبيهات البرنامج النصي المخصصة.

مثل:
"Script_TimeInterval_Min":5

Notification_Groups

مجموعة من الكائنات

 يشير إلى مجموعات التنبيه النشطة باستخدام معرفها وتغيير الوقت. Time shift هو خيار يسمح لك بإنشاء عملية تصعيد تنبيه تستند إلى مدة حالة الخطأ، على سبيل المثال، يمكن إخطار مجموعة الإشعارات الأولى على الفور، والثانية بعد 10 دقائق من وقت التوقف عن العمل، والمجموعة الثالثة بعد 60 دقيقة من وقت التوقف. تتراوح الفواصل الزمنية لتصعيد التنبيه من ثلاث ساعات فورية.

مثل:
"Notification_Groups":
[{
"Id": 608,
"Time_Shift_Min": 10
}, {
"Id": 609,
"Time_Shift_Min": 20
}]

Number_Of_Tasks

إنت32

 قراءة الحقل فقط. يعرض عدد المهام ضمن جهاز محدد.

مثل:
"Number_Of_Tasks": 15

معرف

إنت32

 قراءة الحقل فقط. معرف الجهاز الفريد. يتم تعيينه تلقائيا عند إنشاء جهاز جديد. استخدم لتحديد جهاز في الطلبات.

مثل:
"Id": 8533

Platform_Id

إنت32

 قراءة الحقل فقط. كل منصة (ServerView ، UserView وما إلى ذلك) لها معرف خاص بها. تعرف على كيفية الحصول على معرفات الأنظمة الأساسية هنا.

مثل:
"Platform_Id": 1

اسم

خيط

 اسم الجهاز.

مثل:
"Name": "new name"