Referência da API de gerenciamento de dispositivos para consoles de gerenciamento locais
- Artigo
-
-
Este artigo lista as APIs REST de gerenciamento de dispositivos com suporte para consoles de gerenciamento local do Microsoft Defender para IoT.
dispositivos (Gerenciar dispositivos de sensor de OT)
Use essa API para gerenciar seus dispositivos de sensor de OT de um console de gerenciamento local.
URI: /external/v1/appliances
ou /external/v2/appliances
GET
Sem parâmetros de consulta
Tipo: JSON
Uma matriz JSON de objetos de dispositivo que representam dispositivos de sensor.
Nome |
Type |
Anulável/Não anulável |
Lista de valores |
id |
Long integer |
Não permite valor nulo |
A ID do sensor |
name |
String |
Não permite valor nulo |
O nome do sensor |
interfaceAddress |
String |
Não permite valor nulo |
URL do console do sensor |
state |
Matriz JSON |
Não permite valor nulo |
Uma matriz JSON que descreve o status de conexão do sensor. Para obter mais informações, confira os campos XsenseState. |
version |
String |
Não permite valor nulo |
A versão de software atualmente instalada no sensor. |
alertCount |
Long integer |
Não permite valor nulo |
O número total de alertas atualmente ativos no sensor. |
deviceCount |
Long integer |
Não permite valor nulo |
O número de dispositivos atualmente detectados pelo sensor. |
unhandledAlertsCount |
long |
Não permite valor nulo |
O número atual de alertas sem tratamento no sensor. |
isActivated |
Boolean |
Não permite valor nulo |
Um dos seguintes: Activated ou Unactivated |
dataIntelligenceVersion |
String |
Não permite valor nulo |
A versão dos dados de inteligência contra ameaças atualmente instalados no sensor |
upgradeStatus |
Matriz JSON |
Não permite valor nulo |
Uma matriz JSON que descreve o status de atualização do sensor. Para obter mais informações, confira os campos UpgradeStatusBean. |
upgradeFinishTime |
long |
Nullable |
A hora em que a última atualização de software foi concluída, no seguinte formato: YYYY-MM-DD |
hasLog |
Boolean |
Não permite valor nulo |
Define se existe um log de atualização para o sensor. |
zoneId |
Long integer |
Nullable |
A ID da zona do sensor. |
isInLearningMode |
Boolean |
Não permite valor nulo |
Define se o sensor está atualmente no modo de aprendizagem. |
Campos XsenseState
Nome |
Type |
Anulável/Não anulável |
Lista de valores |
id |
Long integer |
Não permite valor nulo |
Uma ID interna incrementada automaticamente no banco de dados do console de gerenciamento local. |
xsenseId |
Long integer |
Não permite valor nulo |
A ID do sensor. |
connectionState |
Uma matriz JSON de valores de datetime |
Não permite valor nulo |
Um dos seguintes: SYNCED , OUT_OF_SYNC , TIME_DIFF_OFFSET , DISCONNECTED |
cmSyncedUntil |
Datetime |
Não permite valor nulo |
O carimbo de data/hora dos dados mais recentes enviados do sensor. |
sensorSyncedUntil |
Datetime |
Não permite valor nulo |
O carimbo de data/hora da última atualização do console de gerenciamento local para o sensor. |
sensorLastMessage |
Datetime |
Não permite valor nulo |
O carimbo de data/hora da última atualização do sensor. |
Campos UpgradeStatusBean
Nome |
Type |
Anulável/Não anulável |
Lista de valores |
startTime |
Datetime |
Não permite valor nulo |
A hora em que o último processo de atualização foi iniciado. |
percentage |
Valor inteiro entre 0 e 100 |
Não permite valor nulo |
O percentual de conclusão do último processo de atualização. |
stage |
String |
Não permite valor nulo |
Uma das seguintes estátuas:
-
UPLOADING : Carregando pacote
-
PREPARE_TO_INSTALL : Preparando para instalar
-
STOPPING_PROCESSES Interrompendo os processos
-
BACKING_UP_DATA : Fazendo backup de dados
-
TAKING_SNAPSHOT : Capturando instantâneos
-
UPDATING_CONFIGURATION : Atualizando a configuração
-
UPDATING_DEPENDENCIES : Atualizando as dependências
-
UPDATING_LIBRARIES : Atualizando as bibliotecas
-
PATCHING_DATABASES : Aplicando patches nos bancos de dados
-
STARTING_PROCESSES : Iniciando processos
-
VALIDATING_SYSTEM_SANITY : Validando a sanidade do sistema
-
VALIDATION_SUCCEEDED_REBOOTING : Validação bem-sucedida
-
SUCCESS : Êxito
-
FAILURE : Falha
-
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óximas etapas
Para obter mais informações, confira a Visão geral de referência da API do Defender para IoT.