AcquisitionUnitsService_getAcquisitionUnits

Retorna todas as unidades de aquisição com status da conexão, atualização dos relatórios, sistema operacional, versão, endereço IP e contagem de fontes de dados atribuídas.

Exemplo:

AcquisitionUnitsService_getAcquisitionUnitByUuid

Recupera todos os detalhes de uma unidade de aquisição. Se você fornecer um nome, liste primeiro as unidades de aquisição para determinar o UUID correspondente.

Entrada necessária: uuid

ServiçoDeAlertas_obterMetadados

Retorna nomes de campos de alerta e tipos de dados válidos. Chame esta função antes de consultar os alertas.

AlertsService_queryForAlerts

Consulta alertas ativos ou inativos com atributos, filtros, ordenação, limites de tempo e paginação por deslocamento selecionados.

Entradas necessárias:

As entradas opcionais incluem filter, sortField, sortAscending, limit e offset. limit é de 1 a 500; offset é de 0 a 1000. Mantenha o intervalo de tempo abaixo de 30 dias.

Exemplo:

AlertsService_getAlertByName

Recupera um alerta usando um ID de alerta no formato AL-123456.

Entrada necessária: name

AlertsService_getAlertByUUID

Recupera um alerta usando seu UUID.

Entrada necessária: uuid

CollectorService_getDataSources

Lista os coletores configurados com nome, status, fornecedor, modelo, unidade de aquisição, versão e última aquisição bem-sucedida. Opcionalmente, permite filtrar por um UUID de AU.

Exemplo:

CollectorService_getDataSourceById

Recupera um coletor com a configuração, o status do pacote de coleta, a atividade de sondagem, os dispositivos descobertos, as informações de patch e o contexto da unidade de aquisição.

Entrada necessária: id

Use esta ferramenta para intervalos de sondagem, métricas configuradas, configurações de coleta ou investigação de falhas.

CollectorService_getDataSourceTypes

Lista os tipos de produtos compatíveis com o catálogo de coletores do DII. Esta não é uma lista dos coletores configurados no tenant.

LogService_getLogTypes

Lista os tipos de log atualmente disponíveis no locatário.

LogService_getLogTypeMetadata

Retorna os atributos válidos para um tipo de log. Chame esta função antes de pesquisar ou agrupar eventos.

Entrada necessária: type

LogService_queryLogEvents

Retorna os eventos de log em ordem decrescente de data e hora.

Entradas necessárias:

As entradas opcionais incluem attributes, filter, limit e cursor. limit é de 1 a 200. A janela de eventos não pode exceder 30 dias. Passe o cursor da resposta anterior para recuperar a próxima página.

LogService_queryLogEventsCountHistogram

Retorna intervalos de tempo de tamanho fixo com a contagem de eventos. Opcionalmente, agrupe cada intervalo por um atributo agrupável válido; os resultados agrupados retornam os principais segmentos e um segmento "__other__".

Entradas necessárias:

Entradas opcionais: filter, groupBy

MaintenanceWindowService_getMaintenanceWindows

Lista as janelas de supressão de alertas ativas e não expiradas. Defina includeExpired como true para incluir janelas expiradas.

Uma resposta vazia bem-sucedida significa que não existem janelas de manutenção correspondentes.

MaintenanceWindowService_getMaintenanceWindowById

Recupera uma janela de manutenção.

Entrada necessária: id

MonitorsService_queryMonitors

Lista os monitores DII. Use isSystem para retornar apenas os monitores do sistema, excluir os monitores do sistema ou retornar todos os monitores.

MonitorsService_getMonitorById

Recupera um monitor, incluindo sua descrição e orientações corretivas, quando disponíveis.

Entrada necessária: id

NotificationService_getNotificationRules

Lista as regras que encaminham alertas correspondentes para os destinos de notificação. Uma resposta vazia bem-sucedida significa que não existem regras correspondentes.

NotificationService_getNotificationRuleById

Recupera uma regra de roteamento.

Entrada necessária: id

NotificationService_getWebhooks

Lista os metadados de destino do webhook para Slack, Microsoft Teams, Discord, PagerDuty e integrações HTTP personalizadas. Opcionalmente, filtre por tipos de mecanismo separados por vírgula.

Requisito de segurança: endereços de endpoint completos podem conter credenciais. Aplicativos e agentes devem omitir ou ocultar o campo de endereço dos resultados exibidos ou encaminhados.

Exemplo seguro:

ObjectService_getObjectTypes

Lista os tipos de objetos atualmente disponíveis no locatário.

ObjectService_getMetadataForObjectType

Retorna atributos, métricas, tipos e capacidades de agrupamento válidos para um tipo de objeto.

Entrada necessária: objectType

ObjectService_query

Recupera objetos, atributos selecionados e métricas opcionais. Os filtros que fazem referência a métricas aplicam-se aos valores brutos antes da agregação por janela temporal.

Entradas necessárias:

As entradas opcionais incluem metricNames, filter, sortFieldName, isSortAscending, fromTime, toTime, aggregateFunctions, limit, e offset.

Agregações de consulta suportadas: MAX, MIN, AVG, SUM, LAST. limit é de 1 a 500. Se os limites de tempo forem omitidos, a ferramenta usará como padrão uma janela recente de três horas.

ObjectService_groupObjects

Agrupa objetos por um atributo agrupável válido e agrega as métricas selecionadas. Os filtros são aplicados aos valores brutos antes da agregação.

Entradas necessárias:

As entradas opcionais incluem aggregateFunctions, filter, classificação, limites de tempo, limit e offset.

Agregações de grupo suportadas: MAX, MIN, AVG, SUM, FIRST, CHANGE, CHANGE_RATIO.

consultar métricas de desempenho do ObjectService para objetos

Retorna dados de séries temporais agrupados em buckets para uma métrica e os objetos correspondentes.

Entradas necessárias:

As entradas opcionais incluem filter, aggregationFunction, limit, e isSortAscending. limit controla o número de séries retornadas e deve ser de 1 a 50.

Agregações de buckets suportadas: MAX, MIN, AVG, SUM, FIRST, CHANGE, CHANGE_RATIO.

OperatorsManagement_getKubernetesCollectors

Retorna o nome do cluster, o status geral de atualidade, a versão do operador, a versão do componente Network Performance and Map, a versão do componente Change Analysis e o carimbo de data e hora do último relatório.

Exemplo: