مرجع واجهة برمجة تطبيقات التكامل لوحدات التحكم بالإدارة المحلية (معاينة عامة)

مقالة
03/31/2023

تسرد هذه المقالة واجهات برمجة التطبيقات المدعومة لدمج Microsoft Defender ل IoT مع خدمات الشركاء.

على سبيل المثال، يتم تنفيذ واجهة برمجة التطبيقات هذه حاليا مع البرنامج التعليمي: تكامل ServiceNow مع Microsoft Defender ل IoT، عبر ServiceNow Service Graph Connector for Defender for IoT.

ملاحظة

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

للاستعلام ببساطة عن البيانات، استخدم واجهات برمجة التطبيقات العادية غير التكاملية بدلا من ذلك، إما لوحدة تحكم إدارة محلية للاستعلام عن جميع الأجهزة، أو لمستشعر معين للاستعلام عن الأجهزة من هذا المستشعر فقط. لمزيد من المعلومات، راجع مرجع Defender for IoT API.

URI: /external/v3/integration/

الأجهزة (إنشاء الأجهزة وتحديثها)

تقوم واجهة برمجة التطبيقات هذه بإرجاع بيانات حول جميع الأجهزة التي تم تحديثها بعد الطابع الزمني المحدد.

URI: /external/v3/integration/devices/<timestamp>

معلمات URI:

الاسم	الوصف	مثال	مطلوب / اختياري
طابع زمني	وقت البدء الذي يتم إرجاع النتائج منه، بالمللي ثانية من وقت Epoch وفي المنطقة الزمنية UTC.	`/external/v3/integration/devices/1664781014000`	مطلوب

GET

معلمات الاستعلام:

الاسم	الوصف	مثال	مطلوب / اختياري
sensorId	إرجاع الأجهزة التي يراها مستشعر معين فقط. استخدم قيمة المعرف من نتائج واجهة برمجة تطبيقات أدوات الاستشعار (Get sensors).	`1`	‏‏اختياري
نوع الإعلام	تحديد أنواع الأجهزة التي يجب إرجاعها. تشمل القيم المدعومة: - `0`: كل من الأجهزة المحدثة والجديدة (افتراضي). - `1`: أجهزة جديدة فقط. - `2`: الأجهزة المحدثة فقط.	`2`	‏‏اختياري
صفحه	يحدد الرقم الذي يبدأ فيه ترقيم صفحة النتيجة. على سبيل المثال، `0`= الصفحة الأولى هي 0. الافتراضي = `0`	`0`	‏‏اختياري
size	يحدد حجم الصفحة. الافتراضي = `50`	`75`	‏‏اختياري

النوع: JSON

حقول الاستجابة:

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_count	عدد صحيح	غير قابل للقيمة الخالية	عدد الكائنات في مجموعة النتائج الكاملة، بما في ذلك جميع الصفحات.
u_devices	صفيف JSON من عناصر الجهاز	غير قابل للقيمة الخالية	صفيف من عناصر الجهاز، كما هو محدد بواسطة واجهة برمجة تطبيقات الجهاز (الحصول على تفاصيل الجهاز ).

مثال الاستجابة:

{
    "u_devices": [{
        "u_operating_system": "",
        "u_ip_address_objects": [{
            "u_ip_address": "10.10.50.5",
            "u_guessed_mac_addresses": [{
                "u_mac_address": "00:02:a2:1f:1c:59"
            }]
        }],
        "u_zone": "asd",
        "u_name": "10.10.50.5",
        "u_mac_address_objects": [{
            "u_mac_address": "00:02:a2:1f:1c:59"
        }],
        "u_last_update": 1664782919000,
        "u_vendor": "HILSCHER GMBH",
        "u_cm_device_url": "https://<IP address>/#/sites/1/zones/1/devices-maps?devices=1",
        "u_sensor_ids": [{
            "u_sensor_id": 1
        }],
        "u_appliance": "Management console (CM)",
        "u_site": "asd",
        "u_device_type": {
            "u_category": "ICS",
            "u_purdue_layer": "Process Control",
            "u_name": "PLC"
        },
        "u_firmwares": [],
        "u_last_activity": 1664782791000,
        "u_purdue_layer": "N/A",
        "u_device_urls": [{
            "u_device_url": "https://<IP address>9/#/assets/highlight/1"
        }],
        "u_vlans": [{
            "u_vlan": "1"
        }],
        "u_groups": ["asd"],
        "u_first_discovered": 1664781051000,
        "u_id": 1,
        "u_protocol_objects": [{
            "u_protocol": "MODBUS"
        }]
    }, {
        "u_operating_system": "",
        "u_ip_address_objects": [{
            "u_ip_address": "10.10.20.10",
            "u_guessed_mac_addresses": [{
                "u_mac_address": "00:02:a2:1f:02:ba"
            }]
        }],
        "u_zone": "asd",
        "u_name": "10.10.20.10",
        "u_mac_address_objects": [{
            "u_mac_address": "00:02:a2:1f:02:ba"
        }],
        "u_last_update": 1664782859000,
        "u_vendor": "HILSCHER GMBH",
        "u_cm_device_url": "https://<IP address>/#/sites/1/zones/1/devices-maps?devices=50",
        "u_sensor_ids": [{
            "u_sensor_id": 1
        }],
        "u_appliance": "Management console (CM)",
        "u_site": "asd",
        "u_device_type": {
            "u_category": "ICS",
            "u_purdue_layer": "Process Control",
            "u_name": "PLC"
        },
        "u_firmwares": [],
        "u_last_activity": 1664782786000,
        "u_purdue_layer": "N/A",
        "u_device_urls": [{
            "u_device_url": "https://<IP address>9/#/assets/highlight/50"
        }],
        "u_vlans": [{
            "u_vlan": "1"
        }],
        "u_groups": ["asd"],
        "u_first_discovered": 1664781052000,
        "u_id": 50,
        "u_protocol_objects": [{
            "u_protocol": "MODBUS"
        }]
    }],
    "u_count": 204
}

النوع: GET

واجهة برمجة التطبيقات:

curl -k -H "Authorization: <Authorization token>" "https://<IP address>/external/v3/integration/devices/<Timestamp>"

مثال:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" "https://127.0.0.1/external/v3/integration/devices/<Timestamp>"

الاتصالات (الحصول على اتصالات الجهاز)

تقوم واجهة برمجة التطبيقات هذه بإرجاع بيانات حول جميع اتصالات الجهاز التي تم تحديثها بعد الطابع الزمني المحدد.

URI: /external/v3/integration/connections/<timestamp>

معلمات URI:

الاسم	الوصف	مثال	مطلوب / اختياري
طابع زمني	وقت البدء الذي يتم إرجاع النتائج منه، بالمللي ثانية من وقت Epoch وفي المنطقة الزمنية UTC.	`/external/v3/integration/devices/1664781014000`	مطلوب

GET

معلمات الاستعلام:

الاسم	الوصف	مثال	مطلوب / اختياري
صفحه	يحدد الرقم الذي يبدأ فيه ترقيم صفحة النتيجة. على سبيل المثال، `0`= الصفحة الأولى هي 0. الافتراضي = `0`	`0`	‏‏اختياري
size	يحدد حجم الصفحة. الافتراضي = `50`	`75`	‏‏اختياري

النوع: JSON

حقول الاستجابة:

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_count	عدد صحيح	غير قابل للقيمة الخالية	عدد الكائنات في مجموعة النتائج الكاملة، بما في ذلك جميع الصفحات.
u_connections	صفيف JSON من كائنات الاتصال	غير قابل للقيمة الخالية	صفيف من كائنات الاتصال

حقول الاتصالات

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_appliance	سلسلة	غير قابل للقيمة الخالية	اسم المستشعر الذي اكتشف الاتصال.
u_src_device_id	عدد صحيح	غير قابل للقيمة الخالية	معرف الجهاز المصدر للاتصال.
u_src_device_name	سلسلة	غير قابل للقيمة الخالية	اسم الجهاز المصدر للاتصال.
u_dest_device_id	عدد صحيح	غير قابل للقيمة الخالية	معرف الجهاز الوجهة للاتصال.
u_dest_device_name	سلسلة	غير قابل للقيمة الخالية	اسم الجهاز الوجهة للاتصال.
u_connection_type	سلسلة	غير قابل للقيمة الخالية	أحد الإجراءات التالية: `One Way`، `Two Way`، `Multicast`

مثال الاستجابة:

{
    "u_count": 106,
    "u_connections": [{
        "u_src_device_id": 103,
        "u_dest_device_name": "10.10.10.16",
        "u_src_device_name": "10.10.10.18",
        "u_appliance": "Management console (CM)",
        "u_connection_type": "Two Way",
        "u_dest_device_id": 95
    }, {
        "u_src_device_id": 115,
        "u_dest_device_name": "10.10.10.64",
        "u_src_device_name": "10.10.10.30",
        "u_appliance": "Management console (CM)",
        "u_connection_type": "Two Way",
        "u_dest_device_id": 19
    }, {
        "u_src_device_id": 176,
        "u_dest_device_name": "10.10.45.7",
        "u_src_device_name": "10.10.45.100",
        "u_appliance": "Management console (CM)",
        "u_connection_type": "Two Way",
        "u_dest_device_id": 134
    },

النوع: GET

واجهة برمجة التطبيقات:

curl -k -H "Authorization: <Authorization token>" "https://<IP address>/external/v3/integration/connections/1664781014000"

مثال:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" "https://127.0.0.1/external/v3/integration/connections/1664781014000"

الجهاز (الحصول على تفاصيل لجهاز)

ترجع واجهة برمجة التطبيقات هذه بيانات حول جهاز معين لكل معرف جهاز معين.

URI: /external/v3/integration/device/{deviceId}

GET

معلمات الاستعلام:

الاسم	الوصف	مثال	مطلوب / اختياري
deviceId	معرف الجهاز المطلوب على وحدة تحكم الإدارة المحلية	`1`	مطلوب

النوع: JSON

حقول الاستجابة:

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_id	عدد صحيح طويل	غير قابل للقيمة الخالية	معرف الجهاز على وحدة تحكم الإدارة المحلية.
u_vendor	سلسلة	بدون قيمة	اسم مورد الجهاز.
u_appliance	سلسلة	غير قابل للقيمة الخالية	اسم أداة الاستشعار التي اكتشفت الجهاز.
u_mac_address_objects	صفيف سلاسل JSON	غير قابل للقيمة الخالية	صفيف من القيم u_mac_address ، يسرد عناوين MAC الخاصة بالجهاز.
u_groups	صفيف سلاسل JSON	غير قابل للقيمة الخالية	صفيف من المجموعات التي تحتوي على الجهاز.
u_site	سلسلة	غير قابل للقيمة الخالية	اسم موقع الجهاز.
u_zone	سلسلة	غير قابل للقيمة الخالية	اسم موقع الجهاز.
u_last_activity	التاريخ والوقت	غير قابل للقيمة الخالية	الطابع الزمني لآخر مرة كان فيها الجهاز نشطا.
u_first_discovered	التاريخ والوقت	غير قابل للقيمة الخالية	الطابع الزمني لوقت اكتشاف الجهاز.
u_device_type	سلسلة	غير قابل للقيمة الخالية	نوع الجهاز
u_name	سلسلة	غير قابل للقيمة الخالية	يحدد اسم الجهاز.
u_ip_address_objects	صفيف JSON من عناوين IP	غير قابل للقيمة الخالية	صفيف كائنات عنوان IP
u_mac_address_objects	صفيف JSON من عناوين MAC	غير قابل للقيمة الخالية	صفيف كائنات عنوان MAC
u_protocol_objects	صفيف JSON من البروتوكولات	غير قابل للقيمة الخالية	صفيف من عناصر البروتوكول
u_vlans	صفيف JSON لعناصر VLAN	غير قابل للقيمة الخالية	صفيف من كائنات VLAN
u_purdue_layer	سلسلة	غير قابل للقيمة الخالية	يحدد طبقة Purdue الافتراضية لنوع الجهاز هذا.
u_sensor_ids	صفيف JSON من كائنات معرف المستشعر	غير قابل للقيمة الخالية	صفيف من كائنات معرف المستشعر
u_cm_device_url	سلسلة	غير قابل للقيمة الخالية	عنوان URL المستخدم للوصول إلى الجهاز على وحدة تحكم الإدارة المحلية.
u_device_urls	صفيف JSON من عناصر URL	غير قابل للقيمة الخالية	صفيف من عناصر عنوان URL للجهاز
u_last_update	عدد صحيح طويل	غير قابل للقيمة الخالية	يحدد الطابع الزمني لوقت التحديث الأخير للجهاز.
u_firmwares	صفيف JSON من عناصر البرامج الثابتة	غير قابل للقيمة الخالية	صفيف من عناصر البرامج الثابتة

حقول ip_address_object

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_ip_address	سلسلة	غير قابل للقيمة الخالية	أحد عناوين IP للجهاز
u_guessed_mac_address	سلسلة	غير قابل للقيمة الخالية	عناوين MAC التي تم تخمينها المقترنة بعنوان IP

حقول mac_address_object

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_mac_address	سلسلة	غير قابل للقيمة الخالية	أحد عناوين MAC الخاصة بالجهاز.

حقول protocol_object

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_protocol	سلسلة	غير قابل للقيمة الخالية	أحد البروتوكولات المستخدمة من قبل الجهاز.

حقول vlan_object

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_vlan	سلسلة	غير قابل للقيمة الخالية	أحد شبكات VLAN حيث تم العثور على الجهاز.

حقول sensor_id_object

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_sensor_id	سلسلة	غير قابل للقيمة الخالية	معرف المستشعر الذي اكتشف الجهاز.

حقول device_url_object

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_device_url	سلسلة	غير قابل للقيمة الخالية	عناوين URL المستخدمة لعرض الجهاز على وحدة تحكم الإدارة المحلية.

حقول firmware_object

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_appliance	سلسلة	غير قابل للقيمة الخالية	اسم وحدة تحكم الإدارة المحلية التي تدير الجهاز.
u_id	عدد صحيح طويل	غير قابل للقيمة الخالية	معرف الجهاز على وحدة تحكم الإدارة المحلية
u_asset	سلسلة	غير قابل للقيمة الخالية	اسم الجهاز
u_address	سلسلة	غير قابل للقيمة الخالية	عنوان البرنامج الثابت للجهاز
u_module_address	سلسلة	بدون قيمة	عنوان وحدة البرنامج الثابت للجهاز
u_serial	سلسلة	بدون قيمة	الرقم التسلسلي للبرنامج الثابت للجهاز
u_model	سلسلة	بدون قيمة	نموذج البرنامج الثابت للجهاز
u_version	سلسلة	بدون قيمة	إصدار البرنامج الثابت للجهاز
u_additional_data	سلسلة	بدون قيمة	بيانات إضافية خاصة بمورد البرنامج الثابت للجهاز

مثال الاستجابة:

[{
    "u_operating_system": "",
    "u_ip_address_objects": [{
        "u_ip_address": "10.10.50.5",
        "u_guessed_mac_addresses": [{
            "u_mac_address": "00:02:a2:1f:1c:59"
        }]
    }],
    "u_zone": "asd",
    "u_name": "10.10.50.5",
    "u_mac_address_objects": [{
        "u_mac_address": "00:02:a2:1f:1c:59"
    }],
    "u_last_update": 1664782919000,
    "u_vendor": "HILSCHER GMBH",
    "u_cm_device_url": "https://<IP address>/#/sites/1/zones/1/devices-maps?devices=1",
    "u_sensor_ids": [{
        "u_sensor_id": 1
    }],
    "u_appliance": "Management console (CM)",
    "u_site": "asd",
    "u_device_type": {
        "u_category": "ICS",
        "u_purdue_layer": "Process Control",
        "u_name": "PLC"
    },
    "u_firmwares": [],
    "u_last_activity": 1664782791000,
    "u_purdue_layer": "N/A",
    "u_device_urls": [{
        "u_device_url": "https://<IP address>9/#/assets/highlight/1"
    }],
    "u_vlans": [{
        "u_vlan": "1"
    }],
    "u_groups": ["asd"],
    "u_first_discovered": 1664781051000,
    "u_id": 1,
    "u_protocol_objects": [{
        "u_protocol": "MODBUS"
    }]
}]

النوع: GET

واجهة برمجة التطبيقات:

curl -k -H "Authorization: <Authorization token>" "https://<IP address>/external/v3/integration/device/<device ID>"

مثال:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" "https://127.0.0.1/external/v3/integration/device/1"

الأجهزة المحذوفة (الحصول على الأجهزة المحذوفة)

تقوم واجهة برمجة التطبيقات هذه بإرجاع قائمة بمعرفات الأجهزة المحذوفة مؤخرا، من الطابع الزمني المتوفر.

URI: /external/v3/integration/deleteddevices/

GET

معلمات URI:

الاسم	الوصف	مثال	مطلوب / اختياري
طابع زمني	وقت البدء الذي يتم إرجاع النتائج منه، بالمللي ثانية من وقت Epoch وفي المنطقة الزمنية UTC.	`/external/v3/integration/deleteddevices/1664781014000`	مطلوب

النوع: صفيف JSON للأجهزة المحذوفة

حقول الجهاز المحذوفة:

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_id	عدد صحيح طويل	غير قابل للقيمة الخالية	معرف جهاز محذوف

مثال الاستجابة:

[{
    "u_id": 192
}, {
    "u_id": 66
}, {
    "u_id": 4
}, {
    "u_id": 22
}, {
    "u_id": 24
}]

النوع: GET

واجهة برمجة التطبيقات:

curl -k -H "Authorization: <Authorization token>" "https://<IP address>/external/v3/integration/deleteddevices/<timestamp>"

مثال:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" "https://127.0.0.1/external/v3/integration/deleteddevices/1664781014000"

أدوات الاستشعار (الحصول على أدوات الاستشعار)

تقوم واجهة برمجة التطبيقات هذه بإرجاع قائمة كائنات أداة الاستشعار لمستشعرات شبكة OT المتصلة.

URI: /external/v3/integration/sensors/

GET

URI: /sensors

لا توجد معلمات استعلام

النوع: JSON

حقول الاستجابة:

صفيف من الحقول التالية:

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_id	عدد صحيح طويل	غير قابل للإلغاء	يحدد معرف المستشعر الداخلي، الذي سيتم استخدامه في واجهة برمجة تطبيقات الأجهزة (إنشاء الأجهزة وتحديثها ).
u_name	سلسلة	غير قابل للإلغاء	يحدد اسم جهاز الاستشعار.
u_interface_address	سلسلة	غير قابل للإلغاء	يحدد عنوان شبكة جهاز الاستشعار.
u_connection_state	سلسلة	غير قابل للإلغاء	يحدد حالة اتصال الجهاز بوحدة تحكم إدارة محلية، باستخدام إحدى القيم التالية: - تمت المزامنة: الاتصال ناجح. - `OUT_OF_SYNC`: لا يمكن لوحدة تحكم الإدارة المحلية معالجة البيانات المستلمة من أداة الاستشعار. - `TIME_DIFF_OFFSET`: تم الكشف عن انحراف الوقت. تم قطع اتصال وحدة تحكم الإدارة المحلية من أداة الاستشعار. `DISCONNECTED`: أداة الاستشعار لا تتواصل مع وحدة تحكم الإدارة. تحقق من اتصال الشبكة.
u_version	سلسلة	غير قابل للإلغاء	تمثيل سلسلة لإصدار برنامج المستشعر.
u_alert_count	عدد صحيح طويل	غير قابل للإلغاء	العدد الحالي من التنبيهات التي تم تشغيلها بواسطة أداة الاستشعار.
u_device_count	عدد صحيح طويل	غير قابل للإلغاء	العدد الحالي للأجهزة التي تم اكتشافها بواسطة أداة الاستشعار.
u_unhandled_alert_count	عدد صحيح طويل	غير قابل للإلغاء	العدد الحالي للتنبيهات غير المعالجة حاليا على أداة الاستشعار.
u_is_activated	منطقي	غير قابل للإلغاء	يحدد ما إذا كان المستشعر قد تم تنشيطه.
u_data_intelligence_version	سلسلة	غير قابل للإلغاء	تمثيل سلسلة لإصدار التحليل الذكي للمخاطر المثبت على أداة الاستشعار.
u_uid	سلسلة	غير قابل للإلغاء	يحدد المعرف الفريد العمومي للمستشعر.
u_zone_id	عدد صحيح طويل	بدون قيمة	تعريف منطقة الجهاز.
u_is_in_learning_mode	منطقي	غير قابل للإلغاء	تحديد ما إذا كان المستشعر في وضع التعلم.
u_remote_upgrade_stage	سلسلة	بدون قيمة	يحدد مرحلة حالية في عملية تحديث الإصدار كأحد الإجراءات التالية: - `UPLOADING` - `PREPARE_TO_INSTALL` - `STOPPING_PROCESSES` - `BACKING_UP_DATA` - `TAKING_SNAPSHOT` - `UPDATING_CONFIGURATION` - `UPDATING_DEPENDENCIES` - `UPDATING_LIBRARIES` - `PATCHING_DATABASES` - `STARTING_PROCESSES` - `VALIDATING_SYSTEM_SANITY` - `VALIDATION_SUCCEEDED_REBOOTING` - `SUCCESS` - `FAILURE` - `UPGRADE_STARTED` - `STARTING_INSTALLATION` - `INSTALLING_OPERATING_SYSTEM`

مثال الاستجابة:

[
  {
    u_connection_state: "SYNCED",
    u_uid: "fab58081-1fde-4d3f-8eea-9aa723abbd55",
    u_name: "Microsoft Defender for IoT",
    u_is_activated: true,
    u_alert_count: 6,
    u_device_count: 202,
    u_interface_address: "https://<IP address>9",
    u_zone_id: 1,
    u_data_intelligence_version: "May 26, 2022",
    u_is_in_learning_mode: false,
    u_unhandled_alert_count: 6,
    u_remote_upgrade_stage: "",
    u_id: 1,
    u_version: "22.2.5.7-r-2121448",
  },
];

النوع: GET

واجهة برمجة التطبيقات:

curl -k -H "Authorization: <Authorization token>" "https://<IP Address>/external/v3/integration/sensors"

مثال:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" "https://127.0.0.1/external/v3/integration/sensors"

devicecves (الحصول على CVEs للجهاز)

تقوم واجهة برمجة التطبيقات هذه بإرجاع قائمة ب CVEs النشطة لجميع الأجهزة التي تم تحديثها منذ الطابع الزمني المتوفر.

URI: /external/v3/integration/devicecves/

GET

URI: /external/v3/integration/devicecves/<timestamp>

معلمات URI

الاسم	الوصف	مثال	مطلوب / اختياري
طابع زمني	وقت البدء الذي يتم إرجاع النتائج منه، بالمللي ثانية من وقت الفترة وفي المنطقة الزمنية UTC.	`/external/v3/integration/devicecves/1664781014000`	مطلوب

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

الاسم	الوصف	مثال	مطلوب / اختياري
صفحه	يحدد الرقم الذي يبدأ فيه ترقيم صفحة النتيجة.	`0`= الصفحة الأولى هي 0. الافتراضي = `0`	‏‏اختياري
size	يحدد حجم الصفحة.	الافتراضي = `50`	‏‏اختياري
sensorId	يعرض النتائج من أداة استشعار معينة، كما هو محدد بواسطة معرف المستشعر المحدد.	`1`	‏‏اختياري
score	تحديد الحد الأدنى من درجة CVE المراد استردادها. سيكون لجميع النتائج درجة CVE مساوية للقيمة المحددة أو أكبر منها.	الافتراضي = `0`.	‏‏اختياري
معرفات الجهاز	قائمة مفصولة بفواصل بمعرفات الجهاز التي تريد إظهار النتائج منها.	على سبيل المثال:`1232,34,2,456`	‏‏اختياري

النوع: صفيف Count وJSON من CVEs للجهاز

حقول استجابة

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_count	عدد صحيح	غير قابل للإلغاء	عدد العناصر في مجموعة النتائج الكاملة، بما في ذلك جميع الصفحات.
u_device_cves	صفيف JSON لعناصر CVE للجهاز	غير قابل للإلغاء	صفيف من عناصر CVE للجهاز

حقول CVE للجهاز

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_id	عدد صحيح	غير قابل للإلغاء	معرف الجهاز في وحدة تحكم الإدارة المحلية.
u_name	سلسلة	غير قابل للإلغاء	اسم الجهاز.
u_ip_address_objects	صفيف JSON لكائنات عنوان IP	غير قابل للإلغاء	صفيف من قيم u_ip_address ، مع تحديد عناوين IP للأجهزة.
u_mac_address_objects	صفيف JSON لكائنات عنوان MAC	غير قابل للإلغاء	صفيف من قيم u_mac_address ، يسرد عناوين MAC الخاصة بالجهاز.
u_last_activity	عدد صحيح	غير قابل للإلغاء	الطابع الزمني لآخر مرة شوهدت فيها نسبة استخدام الشبكة من الجهاز أو إليه.
u_last_update	عدد صحيح	غير قابل للإلغاء	الطابع الزمني لآخر مرة تم فيها تغيير خاصية على الجهاز، بما في ذلك تغييرات المستخدم وتغييرات النظام التلقائية.
u_cves	صفيف JSON من CVEs	غير قابل للإلغاء	صفيف من عناصر تفاصيل CVE

ملاحظة

إذا كان بإمكان Defender for IoT تحديد عنوان MAC لأحد عناوين IP الخاصة به بثقة، فسيتم إرجاع عنوان MAC في u_mac_address_objects الحقل مباشرة.

إذا لم يكن Defender for IoT واثقا تماما من عنوان MAC، مثل إذا تم توجيه نسبة استخدام الشبكة عبر جهاز توجيه، يتم إرجاع عنوان MAC في u_guessed_mac_address الحقل بدلا من ذلك، كجزء من صفيف JSON من عناوين IP.

حقول u_ip_address_objects

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_ip_address	سلسلة	غير قابل للإلغاء	أحد عناوين IP للجهاز
u_guessed_mac_address	صفيف JSON لكائنات عنوان MAC	غير قابل للإلغاء	صفيف JSON من عناوين MAC

حقول u_mac_address_objects

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_mac_address	سلسلة	غير قابل للإلغاء	أحد عناوين MAC الخاصة بالجهاز

حقول u_cves

الاسم	النوع	Nullable / Not nullable	قائمة بالقيم
u_address	سلسلة	غير قابل للإلغاء	عنوان الواجهة المحددة، مع البرنامج الثابت المحدد حيث تم الكشف عن CVE.
u_cve_id	سلسلة	غير قابل للإلغاء	تعريف معرف CVE
u_score	سلسلة	غير قابل للإلغاء	يحدد درجة مخاطر CVE
u_attack_vector	سلسلة	غير قابل للإلغاء	يعرف متجه الهجوم على أنه أحد الإجراءات التالية: `ADJACENT_NETWORK`، ، `LOCALNETWORK`
u_description	سلسلة	غير قابل للقيمة الخالية	تعريف وصف CVE

مثال الاستجابة:

{
    "u_count": 2,
    "u_device_cves": [{
        "u_ip_address_objects": [{
            "u_ip_address": "192.168.1.127",
            "u_guessed_mac_addresses": [{
                "u_mac_address": "00:0f:38:67:4f:1c"
            }]
        }],
        "u_name": "192.168.1.127",
        "u_mac_address_objects": [{
            "u_mac_address": "00:0f:38:67:4f:1c"
        }],
        "u_last_update": 1664787209000,
        "u_last_activity": 1664782792000,
        "u_id": 135,
        "u_cves": [{
            "u_cve_id": "CVE-2015-2373",
            "u_score": "10.0",
            "u_ip_address": "192.168.1.127",
            "u_description": "The Remote Desktop Protocol (RDP) server service in Microsoft Windows 7 SP1, Windows 8, and Windows Server 2012 allows remote attackers to execute arbitrary code via a series of crafted packets, aka \"Remote Desktop Protocol (RDP) Remote Code Execution Vulnerability.\"",
            "u_attack_vector": "NETWORK"
        }, {
            "u_cve_id": "CVE-2015-1635",
            "u_score": "10.0",
            "u_ip_address": "192.168.1.127",
            "u_description": "HTTP.sys in Microsoft Windows 7 SP1, Windows Server 2008 R2 SP1, Windows 8, Windows 8.1, and Windows Server 2012 Gold and R2 allows remote attackers to execute arbitrary code via crafted HTTP requests, aka \"HTTP.sys Remote Code Execution Vulnerability.\"",
            "u_attack_vector": "NETWORK"
        }, {
            "u_cve_id": "CVE-2015-0014",
            "u_score": "10.0",
            "u_ip_address": "192.168.1.127",
            "u_description": "Buffer overflow in the Telnet service in Microsoft Windows Server 2003 SP2, Windows Vista SP2, Windows Server 2008 SP2 and R2 SP1, Windows 7 SP1, Windows 8, Windows 8.1, and Windows Server 2012 Gold and R2 allows remote attackers to execute arbitrary code via crafted packets, aka \"Windows Telnet Service Buffer Overflow Vulnerability.\"",
            "u_attack_vector": "NETWORK"
        }]
    }, {
        "u_ip_address_objects": [{
            "u_ip_address": "10.13.10.5",
            "u_guessed_mac_addresses": [{
                "u_mac_address": "00:05:f0:00:0f:cd"
            }]
        }],
        "u_name": "10.13.10.5",
        "u_mac_address_objects": [{
            "u_mac_address": "00:05:f0:00:0f:cd"
        }],
        "u_last_update": 1664787149000,
        "u_last_activity": 1664782792000,
        "u_id": 181,
        "u_cves": [{
            "u_cve_id": "CVE-2016-7182",
            "u_score": "10.0",
            "u_ip_address": "10.13.10.5",
            "u_description": "The Graphics component in Microsoft Windows Vista SP2; Windows Server 2008 SP2 and R2 SP1; Windows 7 SP1; Windows 8.1; Windows Server 2012 Gold and R2; Windows RT 8.1; Windows 10 Gold, 1511, and 1607; Office 2007 SP3; Office 2010 SP2; Word Viewer; Skype for Business 2016; Lync 2013 SP1; Lync 2010; Lync 2010 Attendee; and Live Meeting 2007 Console allows attackers to execute arbitrary code via a crafted True Type font, aka \"True Type Font Parsing Elevation of Privilege Vulnerability.\"",
            "u_attack_vector": "NETWORK"
        }, {
            "u_cve_id": "CVE-2016-3270",
            "u_score": "10.0",
            "u_ip_address": "10.13.10.5",
            "u_description": "The Graphics component in the kernel in Microsoft Windows Vista SP2; Windows Server 2008 SP2 and R2 SP1; Windows 7 SP1; Windows 8.1; Windows Server 2012 Gold and R2; Windows RT 8.1; and Windows 10 Gold, 1511, and 1607 allows local users to gain privileges via a crafted application, aka \"Win32k Elevation of Privilege Vulnerability.\"",
            "u_attack_vector": "NETWORK"
        }, {
            "u_cve_id": "CVE-2016-3266",
            "u_score": "10.0",
            "u_ip_address": "10.13.10.5",
            "u_description": "The kernel-mode drivers in Microsoft Windows Vista SP2, Windows Server 2008 SP2 and R2 SP1, Windows 7 SP1, Windows 8.1, Windows Server 2012 Gold and R2, Windows RT 8.1, and Windows 10 Gold, 1511, and 1607 allow local users to gain privileges via a crafted application, aka \"Win32k Elevation of Privilege Vulnerability,\" a different vulnerability than CVE-2016-3376, CVE-2016-7185, and CVE-2016-7211.",
            "u_attack_vector": "NETWORK"
        }]
    }]
}

النوع: GET

واجهة برمجة التطبيقات:

curl -k -H "Authorization: <Authorization token>" "https://<IP Address>/external/v3/integration/devicecves/<timestamp>"

مثال:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" "https://127.0.0.1/external/v3/integration/devicecves/1664781014000"

الخطوات التالية

لمزيد من المعلومات، انظر:

مشاركة عبر

مرجع واجهة برمجة تطبيقات التكامل لوحدات التحكم بالإدارة المحلية (معاينة عامة)

الأجهزة (إنشاء الأجهزة وتحديثها)

GET

مثال الاستجابة:

الاتصالات (الحصول على اتصالات الجهاز)

GET

حقول الاتصالات

مثال الاستجابة:

الجهاز (الحصول على تفاصيل لجهاز)

GET

حقول ip_address_object

حقول mac_address_object

حقول protocol_object

حقول vlan_object

حقول sensor_id_object

حقول device_url_object

حقول firmware_object

مثال الاستجابة:

الأجهزة المحذوفة (الحصول على الأجهزة المحذوفة)

GET

مثال الاستجابة:

أدوات الاستشعار (الحصول على أدوات الاستشعار)

GET

مثال الاستجابة:

devicecves (الحصول على CVEs للجهاز)

GET

معلمات URI

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

حقول استجابة

حقول CVE للجهاز

حقول u_ip_address_objects

حقول u_mac_address_objects

حقول u_cves

مثال الاستجابة:

الخطوات التالية

الملاحظات

الموارد الإضافية