Referencia de api de administración de dispositivos para consolas de administración locales

En este artículo se enumeran las API rest de administración de dispositivos compatibles con las consolas de administración locales de Microsoft Defender para IoT.

dispositivos (administrar dispositivos de sensor de OT)

Use esta API para administrar los dispositivos del sensor de OT desde una consola de administración local.

URI: /external/v1/appliances o /external/v2/appliances

OBTENER

Sin parámetros de consulta

tipo: JSON

Matriz JSON de objetos de dispositivo que representan dispositivos de sensor.

Nombre	Tipo	Admite valores NULL/No acepta valores NULL	Lista de valores
de identificador de	Entero largo	No acepta valores NULL	El identificador del sensor
nombre	Cuerda	No acepta valores NULL	Nombre del sensor
interfaz de Address	Cuerda	No acepta valores NULL	Dirección URL de la consola del sensor
de estado de	Matriz JSON	No acepta valores NULL	Matriz JSON que describe el estado de conexión del sensor. Para obtener más información, vea campos XsenseState.
de versión de	Cuerda	No acepta valores NULL	La versión de software instalada actualmente en el sensor.
alertCount	Entero largo	No acepta valores NULL	El número total de alertas actualmente activas en el sensor.
deviceCount	Entero largo	No acepta valores NULL	Número de dispositivos detectados actualmente por el sensor.
unhandledAlertsCount	largo	No acepta valores NULL	Número actual de alertas no controladas en el sensor.
isActivated	Booleano	No acepta valores NULL	Uno de los siguientes: Activated o Unactivated
dataIntelligenceVersion	Cuerda	No acepta valores NULL	La versión de los datos de inteligencia sobre amenazas instalados actualmente en el sensor
upgradeStatus	Matriz JSON	No acepta valores NULL	Matriz JSON que describe el estado de actualización del sensor. Para obtener más información, vea campos UpgradeStatusBean.
upgradeFinishTime	Largo	Nullable	La hora en que se completó la última actualización de software, con el siguiente formato: YYYY-MM-DD
hasLog	Booleano	No acepta valores NULL	Define si existe un registro de actualización para el sensor.
zoneId	Entero largo	Nullable	Identificador de la zona del sensor.
isInLearningMode	Booleano	No acepta valores NULL	Define si el sensor está actualmente en modo de aprendizaje.

Campos XsenseState

Nombre	Tipo	Admite valores NULL/No acepta valores NULL	Lista de valores
de identificador de	Entero largo	No acepta valores NULL	Un identificador interno de incremento automático en la base de datos de la consola de administración local.
xsenseId	Entero largo	No acepta valores NULL	Identificador del sensor.
connectionState	Matriz JSON de valores datetime	No acepta valores NULL	Uno de los siguientes: SYNCED, OUT_OF_SYNC, TIME_DIFF_OFFSET, DISCONNECTED
cmSyncedUntil	DateTime	No acepta valores NULL	Marca de tiempo de los datos más recientes enviados desde el sensor.
sensorSyncedUntil	DateTime	No acepta valores NULL	Marca de tiempo de la última actualización de la consola de administración local al sensor.
sensorLastMessage	DateTime	No acepta valores NULL	Marca de tiempo de la última actualización del sensor.

Campos UpgradeStatusBean

Nombre	Tipo	Admite valores NULL/No acepta valores NULL	Lista de valores
startTime	DateTime	No acepta valores NULL	Hora en que se inició el último proceso de actualización.
porcentaje	Entero entre 0 y 100	No acepta valores NULL	Porcentaje de finalización del último proceso de actualización.
fase	Cuerda	No acepta valores NULL	Una de las siguientes estatuas: - UPLOADING: Carga del paquete - PREPARE_TO_INSTALL: Preparación para instalar - STOPPING_PROCESSES detener procesos - BACKING_UP_DATA: copia de seguridad de datos - TAKING_SNAPSHOT: Tomar instantánea - UPDATING_CONFIGURATION: Actualización de la configuración - UPDATING_DEPENDENCIES: Actualización de dependencias - UPDATING_LIBRARIES: Actualización de bibliotecas - PATCHING_DATABASES: Aplicación de revisiones a bases de datos - STARTING_PROCESSES: Iniciar procesos - VALIDATING_SYSTEM_SANITY: Validación de la integridad del sistema - VALIDATION_SUCCEEDED_REBOOTING: validación correcta - SUCCESS: Correcto - FAILURE: Error - UPGRADE_STARTED: Actualización iniciada - STARTING_INSTALLATION: Iniciar la instalación - INSTALLING_OPERATING_SYSTEM: Instalación del sistema operativo

Ejemplo de respuesta

[
 {
    "dataIntelligenceVersion":"Dec 22, 2021",
    "name":"Microsoft Defender for IoT",
    "isActivated":true,
    "hasLog":false,
    "zoneId":null,
    "upgradeStatus":null,
    "deviceCount":22,
    "state":{
       "sensorLastMessage":1660217831000,
       "xsenseId":1,
       "sensorSyncedUntil":1660217741000,
       "connectionState":{
          "isConsideredConnected":true,
          "id":1,
          "description":"Connection is successful"
       },
       "cmSyncedUntil":1660217825000,
       "id":1
    },
    "version":"22.1.4.8-r-6372aad",
    "alertCount":9,
    "upgradeFinishTime":null,
    "uid":"a6218f1a-8ebf-4bb3-8613-c859b17eef01",
    "interfaceAddress":"https://173.70.549.76",
    "id":1,
    "unhandledAlertsCount":9
  }
]

comando cURL

tipo: GET

de API de :

curl -k -H "Authorization: <AUTH_TOKEN>" 'https://<>IP_ADDRESS>/external/v1/appliances'

ejemplo:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" 'https://127.0.0.1/external/v1/appliances'

Pasos siguientes

Para obtener más información, consulte la introducción a la referencia de la API de Defender para IoT.