Referência da API de gerenciamento de dispositivos para consoles de gerenciamento locais

Artigo
08/11/2022

Este artigo lista as APIs REST de gerenciamento de dispositivos com suporte para consoles de gerenciamento locais do Microsoft Defender for IoT.

aparelhos (Gerenciar aparelhos com sensor OT)

Use esta API para gerenciar seus dispositivos de sensor OT a partir de um console de gerenciamento local.

URI: /external/v1/appliances ou /external/v2/appliances

OBTER

Sem parâmetros de consulta

Tipo: JSON

Uma matriz JSON de objetos de dispositivo que representam dispositivos de sensor.

Designação	Tipo	Nulo / Não anulável	Lista de valores
id	Inteiro longo	Não anulável	O ID do sensor
nome	String	Não anulável	O nome do sensor
interfaceEndereço	String	Não anulável	URL da consola do sensor
estado	Matriz JSON	Não anulável	Uma matriz JSON que descreve o status da conexão do sensor. Para obter mais informações, consulte campos XsenseState.
versão	String	Não anulável	A versão do software atualmente instalada no sensor.
alertCount	Inteiro longo	Não anulável	O número total de alertas atualmente ativos no sensor.
deviceCount	Inteiro longo	Não anulável	O número de dispositivos atualmente detetados pelo sensor.
unhandledAlertsCount	Longo	Não anulável	O número atual de alertas não tratados no sensor.
isActivated	Booleano	Não anulável	Um dos seguintes: `Activated` ou `Unactivated`
dataIntelligenceVersion	String	Não anulável	A versão dos dados de inteligência de ameaças atualmente instalados no sensor
upgradeStatus	Matriz JSON	Não anulável	Uma matriz JSON que descreve o status de atualização do sensor. Para obter mais informações, consulte campos UpgradeStatusBean.
upgradeFinishTime	Longo	Nulo	A hora em que a última atualização de software foi concluída, no seguinte formato: `YYYY-MM-DD`
hasLog	Booleano	Não anulável	Define se existe um log de atualização para o sensor.
zoneId	Inteiro longo	Nulo	O ID da zona do sensor.
isInLearningMode	Booleano	Não anulável	Define se o sensor está atualmente no modo de aprendizagem.

Campos XsenseState

Designação	Tipo	Nulo / Não anulável	Lista de valores
id	Inteiro longo	Não anulável	Uma ID interna incrementada automaticamente no banco de dados do console de gerenciamento local.
xsenseId	Inteiro longo	Não anulável	O ID do sensor.
connectionState	Uma matriz JSON de valores datetime	Não anulável	Um dos seguintes: `SYNCED`, `OUT_OF_SYNC`, `TIME_DIFF_OFFSET`, `DISCONNECTED`
cmSyncedAté	Data/Hora	Não anulável	O carimbo de data/hora dos dados mais recentes enviados a partir do sensor.
sensorSyncedAté	Data/Hora	Não anulável	O carimbo de data/hora da última atualização do console de gerenciamento local para o sensor.
sensorLastMessage	Data/Hora	Não anulável	O carimbo de data/hora da última atualização do sensor.

Campos UpgradeStatusBean

Designação	Tipo	Nulo / Não anulável	Lista de valores
startTime	Data/Hora	Não anulável	A hora em que o último processo de atualização foi iniciado.
percentagem	Inteiro entre 0-100	Não anulável	A porcentagem de conclusão do último processo de atualização.
estágio	String	Não anulável	Uma das seguintes estátuas: - `UPLOADING`: Upload de pacote - `PREPARE_TO_INSTALL`: Preparando-se para instalar - `STOPPING_PROCESSES` Parar processos - `BACKING_UP_DATA`: Fazendo backup de dados - `TAKING_SNAPSHOT`: Tirar instantâneo - `UPDATING_CONFIGURATION`: Atualizando a configuração - `UPDATING_DEPENDENCIES`: Atualizando dependências - `UPDATING_LIBRARIES`: Atualizando bibliotecas - `PATCHING_DATABASES`: Patching Databases - `STARTING_PROCESSES`: Iniciando processos - `VALIDATING_SYSTEM_SANITY`: Validando a sanidade do sistema - `VALIDATION_SUCCEEDED_REBOOTING`: Validação bem-sucedida - `SUCCESS`: Sucesso - `FAILURE`: Fracasso - `UPGRADE_STARTED`: Atualização iniciada - `STARTING_INSTALLATION`: Iniciando a instalação - `INSTALLING_OPERATING_SYSTEM`: Instalando o sistema operacional

Exemplo de resposta

[
 {
    "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
  }
]

Tipo: GET

API:

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

Exemplo:

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

Próximos passos

Para obter mais informações, consulte a visão geral de referência da API do Defender for IoT.

Partilhar via