As informações mais recentes da API podem ser encontradas fazendo login no Data Infrastructure Insights e navegando até Admin > API Acccess. 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 da API e permite que você a experimente 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 para você podem variar.

Antes de usar a API do Data Infrastructure Insights , você deve criar um ou mais API Access Tokens. 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 de cada token de acesso. Todas as APIs sob os tipos especificados são válidas para o token de acesso. Cada token não possui nome de usuário ou senha.

Para criar um Token de Acesso:

Você pode desabilitar, habilitar e revogar tokens. Tokens que estão desabilitados podem ser habilitados.

Os tokens concedem acesso de propósito geral às APIs da perspectiva 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 da equipe 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 sucesso e, em seguida, 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 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:

Veja as páginas do Swagger para exemplos específicos da API que você deseja usar.

A API Data Infrastructure Insights é baseada em categorias 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 em"Documentação da API Swagger" .

Observe que os tipos de API aos quais um usuário tem acesso dependem também da"Função do usuário" eles têm em cada conjunto de recursos do Data Infrastructure Insights (Monitoramento, Segurança de Carga de Trabalho, Relatórios).

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

Muitos comandos de 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 é expands. 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, uma URL ou ambos. O parâmetro expand 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 a expansão de dados para todos os objetos de armazenamento de uma só vez. Os clientes precisam recuperar a lista de objetos e então escolher objetos específicos para expandir.

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 acesso tanto às amostras quanto aos dados resumidos. Para um objeto com dados de desempenho, um resumo de desempenho está disponível como expand=performance. As séries temporais do histórico de desempenho estão disponíveis por meio de expand=performance.history aninhado.

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 término da amostra e uma coleção de valores resumidos (atual, mínimo, máximo, médio, etc.) calculados a partir de um único contador de desempenho em um intervalo de tempo (1 hora, 24 horas, 3 dias e assim por diante).

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 oferece suporte a “diskThroughput” como uma métrica de desempenho. Cada métrica de desempenho suportada é de uma determinada “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étricas de desempenho também terá o campo “descrição”, que é uma descrição legível dessa métrica de desempenho e um conjunto de entradas de contador de resumo de desempenho.

O contador Resumo de Desempenho é o resumo dos contadores de desempenho. Ele apresenta valores agregados típicos como mínimo, máximo e médio para um contador e também o último valor observado, intervalo de tempo para dados resumidos, tipo de unidade para contador e limites para dados. Somente os limites são opcionais; o restante dos atributos são obrigatórios.

Resumos de desempenho estão disponíveis para estes tipos de contadores:

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

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

Os dados históricos são apresentados nos dados de desempenho como uma lista de pares de mapas de registro de data e hora e de contador.

Os contadores de histórico são nomeados com base no nome do objeto de métrica de desempenho. Por exemplo, o objeto de desempenho da máquina virtual suporta “diskThroughput”, então o mapa de histórico conterá 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 formato livre e o JSON resultante contém uma lista categorizada de resultados. Tipos são diferentes tipos de ativos do Inventário, como armazenamentos, hosts, dataStores e assim por diante. Cada tipo conteria uma lista de objetos do tipo que correspondem aos critérios de pesquisa.

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

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

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

Para remover permanentemente um token de API, no menu, selecione "Revogar". Você não pode 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.