As informações mais recentes da API são encontradas efetuando login no Data Infrastructure Insights e navegando para Admin > API Access. Clique no link Documentação da API.

A Documentação da API é baseada no Swagger, que fornece uma breve descrição e informações de uso para a API, e permite que você experimente isso em seu locatário. Dependendo da sua função de usuário e/ou edição do Data Infrastructure Insights, os tipos de API disponíveis podem variar.

Antes de usar a API Data Infrastructure Insights, você deve criar um ou mais tokens de acesso à API. Os tokens de acesso são usados para tipos de API especificados e podem conceder permissões de leitura e/ou gravação. Você também pode definir a expiração para cada token de acesso. Todas as APIs sob os tipos especificados são válidas para o token de acesso. Cada token é nulo de um nome de usuário ou senha.

Para criar um token de acesso:

Você pode desativar, ativar e revogar tokens. Os tokens que estão desativados podem ser ativados.

Os tokens concedem acesso de propósito geral às APIs da perspetiva do cliente, gerenciando o acesso às APIs no escopo de seu próprio locatário. Os administradores do cliente podem conceder e revogar esses tokens sem envolvimento direto do pessoal de back-end do Data Infrastructure Insights.

O aplicativo recebe um token de acesso depois que um usuário autentica e autoriza o acesso com êxito e passa o token de acesso como uma credencial quando chama a API de destino. O token passado informa à API que o portador do token foi autorizado a acessar a API e executar ações específicas especificadas pelo escopo que foi concedido durante a autorização.

O cabeçalho HTTP onde o token de acesso é passado é X-CloudInsights-ApiKey:.

Por exemplo, use o seguinte para recuperar ativos de armazenamento:

Consulte as páginas de swagger para obter exemplos específicos da API que você deseja usar.

A API Data Infrastructure Insights é baseada em categoria e atualmente contém os seguintes tipos:

Tipos e/ou APIs adicionais podem ficar disponíveis ao longo do tempo. Você pode encontrar as informações mais recentes da API no "Documentação do Swagger API".

Observe que os tipos de API aos quais um usuário tem acesso dependem também dos "Função de utilizador" que eles têm em cada conjunto de recursos do Data Infrastructure Insights (monitoramento, segurança de workload, relatórios).

Esta seção descreve como atravessar uma hierarquia de objetos do Data Infrastructure Insights.

Muitos comandos API suportam o parâmetro expand, que fornece detalhes adicionais sobre o objeto ou URLs para objetos relacionados.

O único parâmetro de expansão comum é expansions. A resposta contém uma lista de todas as expansões específicas disponíveis para o objeto.

Por exemplo, quando você solicita o seguinte:

Cada expansão contém dados, um URL ou ambos. O parâmetro expandir suporta atributos múltiplos e aninhados, por exemplo:

Para desencorajar isso, as solicitações de coleções de nível superior não podem ser expandidas. Por exemplo, você não pode solicitar dados de expansão para todos os objetos de armazenamento de uma só vez. Os clientes são obrigados a recuperar a lista de objetos e, em seguida, escolher objetos específicos para expandir.

Os dados de desempenho são coletados em vários dispositivos como amostras separadas. A cada hora (o padrão), o Data Infrastructure Insights agrega e resume amostras de desempenho.

A API permite o acesso a amostras e aos dados resumidos. Para um objeto com dados de desempenho, um resumo de desempenho está disponível como _expand As séries temporais do histórico de desempenho estão disponíveis através de

Exemplos de objetos de dados de desempenho incluem:

Uma métrica de desempenho tem uma descrição e um tipo e contém uma coleção de resumos de desempenho. Por exemplo, latência, tráfego e taxa.

Um Resumo de desempenho tem uma descrição, unidade, hora de início da amostra, hora de fim da amostra e uma coleção de valores resumidos (corrente, min, máx, média, etc.) calculados a partir de um único contador de desempenho em um intervalo de tempo (1 hora, 24 horas, 3 dias, etc.).

O dicionário de dados de desempenho resultante tem as seguintes chaves:

Cada tipo de objeto de dados de desempenho tem um conjunto exclusivo de métricas de desempenho. Por exemplo, o objeto de desempenho da Máquina Virtual suporta "diskThroughput" como uma métrica de desempenho. Cada métrica de desempenho suportada é de uma certa "performanceCategory" apresentada no dicionário de métricas. O Data Infrastructure Insights oferece suporte a vários tipos de métricas de desempenho listados posteriormente neste documento. Cada dicionário de métrica de desempenho também terá o campo "descrição" que é uma descrição legível por humanos dessa métrica de desempenho e um conjunto de entradas de contador de resumo de desempenho.

O contador de Resumo de desempenho é o resumo dos contadores de desempenho. Apresenta valores agregados típicos como min, Max e avg para um contador e também o valor observado mais recente, intervalo de tempo para dados resumidos, tipo de unidade para contador e limiares para dados. Apenas os limites são opcionais; o resto dos atributos são obrigatórios.

Estão disponíveis resumos de desempenho para estes tipos de contadores:

A API pode retornar métricas detalhadas para objetos no seu locatário, por exemplo:

Consulte o "Documentação do Swagger API" para obter informações sobre métricas para cada tipo de objeto.

Os dados de histórico são apresentados em dados de desempenho como uma lista de pares de mapas de carimbo de data/hora e contador.

Os contadores de histórico são nomeados com base no nome do objeto da métrica de desempenho. Por exemplo, o objeto de desempenho da máquina virtual suporta "diskThroughput" para que o mapa de histórico contenha chaves chamadas "diskThroughput.read", "diskThroughput.write" e "diskThroughput.total".

A seguir está um exemplo de um JSON de dados de desempenho para um disco:

Objetos com atributos de capacidade usam tipos de dados básicos e o CapacityItem para representação.

A API de pesquisa é um ponto de entrada simples para o sistema. O único parâmetro de entrada para a API é uma string de forma livre e o JSON resultante contém uma lista categorizada de resultados. Os tipos são tipos de ativos diferentes do Inventário, como armazenamentos, hosts, datastores e assim por diante. Cada tipo conterá uma lista de objetos do tipo que correspondem aos critérios de pesquisa.

O Data Infrastructure Insights é uma solução extensível (aberta) que permite integrações com sistemas de orquestração, gerenciamento de negócios, controle de alterações e emissão de tíquetes, bem como integrações personalizadas de CMDB.

A API RESTful do Cloud Insight é um ponto de integração principal que permite a movimentação simples e eficaz de dados, além de permitir que os usuários obtenham acesso otimizado aos dados.

Para desativar temporariamente um token de API, na página de lista de token de API, clique no menu "três pontos" da API e selecione Desativar. Você pode reativar o token a qualquer momento usando o mesmo menu e selecionando enable.

Para remover permanentemente um token de API, no menu, selecione "revogar". Não é possível reativar um token revogado; você deve criar um novo token.

Os tokens de acesso à API têm uma data de validade. Quando um token de acesso à API expira, os usuários precisam gerar um novo token (do tipo ingestão de dados com permissões de leitura/gravação) e reconfigurar o Telegraf para usar o token recém-gerado em vez do token expirado. As etapas abaixo detalham como fazer isso.