Referencia de la API de administración de dispositivos para las consolas de administración locales

Este artículo enumera las API de REST de administración de dispositivos compatibles con consolas de administración locales de Microsoft Defender para IoT.

dispositivos (Administración de los dispositivos de sensores 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

GET

Solicitud

No hay parámetros de consulta

Respuesta

Tipo: JSON

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

Nombre	Tipo	Que admite valores NULL / No admite valores NULL	Lista de valores
id	Entero largo	No acepta valores NULL	El identificador del sensor
name	String	No acepta valores NULL	Nombre del sensor
interfaceAddress	String	No acepta valores NULL	Dirección URL de la consola del sensor
state	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.
version	String	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 actual de dispositivos detectados por el sensor.
unhandledAlertsCount	long	No acepta valores NULL	Número de alertas no controladas actualmente en el sensor.
isActivated	Boolean	No acepta valores NULL	Uno de los siguientes: Activated o Unactivated
dataIntelligenceVersion	String	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	long	Nullable	La hora en que se completó la última actualización de software, en el siguiente formato: YYYY-MM-DD
hasLog	Boolean	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	Boolean	No acepta valores NULL	Define si el sensor está actualmente en modo de aprendizaje.

XsenseState fields

Nombre	Tipo	Que admite valores NULL / No admite valores NULL	Lista de valores
id	Entero largo	No acepta valores NULL	Un identificador interno e incrementado automáticamente en la base de datos de la consola de administración local.
xsenseId	Entero largo	No acepta valores NULL	El 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.

UpgradeStatusBean fields

Nombre	Tipo	Que admite valores NULL / No admite valores NULL	Lista de valores
startTime	DateTime	No acepta valores NULL	Hora en que se inició el último proceso de actualización.
percentage	Número entero comprendido entre 0 y 100.	No acepta valores NULL	Porcentaje de finalización del último proceso de actualización.
fase	String	No acepta valores NULL	Uno de los siguientes estados: - UPLOADING: Cargando el paquete - PREPARE_TO_INSTALL: Preparando la instalación - STOPPING_PROCESSES: Deteniendo procesos - BACKING_UP_DATA: Realizando una copia de seguridad de los datos - TAKING_SNAPSHOT: Tomando instantánea - UPDATING_CONFIGURATION: Actualizando la configuración - UPDATING_DEPENDENCIES: Actualizando dependencias - UPDATING_LIBRARIES: Actualizando bibliotecas - PATCHING_DATABASES: Aplicando revisiones a las bases de datos - STARTING_PROCESSES: Iniciando procesos - VALIDATING_SYSTEM_SANITY: Comprobando la integridad del sistema - VALIDATION_SUCCEEDED_REBOOTING: Validación correcta - SUCCESS: Correcto - FAILURE: Error - UPGRADE_STARTED: Se ha iniciado la actualización - STARTING_INSTALLATION: Iniciando 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

API:

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 información general de referencia de API de Defender para IoT.