Como arquiteto do Insights de APIs, obtenha informações sobre o desempenho, os relacionamentos e a governança da API da sua organização na página de detalhes da API no espaço Insights de APIs.
A página de detalhes da API no espaço Insights de APIs apresenta uma exibição detalhada do status operacional, uso, segurança e relacionamentos de uma API em CMDB.Figura 1. Página de detalhes da API.
Acesso e uso da página de detalhes da API
Para acessar a página de detalhes da API, navegue até Espaços > Insights de APIs, selecione a guia APIs e selecione uma API na coluna Nome da tabela de APIs.
Exibe o nome da API, as informações da versão e a fase do ciclo de vida atual da API, como Operacional ou Fim da vida útil.
A lista Exibir por permite alternar entre diferentes plataformas de gestão, se disponíveis, nas quais a API é gerenciada.
O seletor de versão permite a seleção de diferentes versões da API para exibir e gerenciar. Selecione Atualizar para atualizar os detalhes com base na versão selecionada.
Nota:
A lista Exibir por e o seletor de versão são exibidos apenas se aplicáveis a uma API.
Região de metadados
Exibe os campos a seguir.
Campo
Descrição
Descrição
Breve resumo ou finalidade da API.
Última descoberta em
Última data em que a API foi descoberta ou atualizada no CMDB.
Origem da descoberta
Origem de onde a API foi descoberta.
Tipo
Tipo de API: REST API com script, HTTP API, plataforma REST API e assim por diante.
Grupo responsável
Equipe ou grupo responsável por gerenciar a API.
Interface digital
Método de interação da API no sistema.
Listas relacionadas
Exibe os campos a seguir.
Campo
Descrição
Solicitações de acesso recebidas
Exibe o número de solicitações de acesso feitas para a API. Selecione o número mostrado no cartão para exibir detalhes das solicitações de acesso.
Consumidores
Exibe o número de consumidores da API.
Implantações
Indica quaisquer implantações ativas ou anteriores da API em ambientes.
Painel de visão geral
Lista todas as operações disponíveis (endpoints) da API. Selecione um endpoint para exibir seus detalhes.
Uso
Exibe os campos a seguir.
Campo
Descrição
Solicitações diárias
Número de solicitações de componente de API ao longo do tempo, representado como um gráfico de linhas, com o eixo x mostrando o intervalo de datas e o eixo y exibindo a contagem de solicitações.
Solicitações por versão (últimos 10 dias)
Distribuição de solicitação de API em diferentes versões nos últimos 10 dias.
Aplicações de negócios
Número de contexto de negócios também chamado de aplicação de negócios vinculado ao design da API, conforme refletido no registro da interface digital.
Segurança
Exibe os campos a seguir.
Campo
Descrição
Itens ativos de vulnerabilidade
Vulnerabilidades de segurança associadas à API que permitem rastrear e eliminar riscos em potencial.
Incidentes de segurança
A opção Incidentes de segurança, se habilitada, fornece informações sobre violações ou problemas de segurança que podem ter ocorrido com a API.
Eventos
Exibe os campos a seguir.
Campo
Descrição
Alertas críticos
Alertas críticos gerados por operações de TI relacionadas à API que permitem identificar os principais problemas capazes de afetar o desempenho da API.
Incidentes
Incidentes registrados, como indisponibilidades, solicitações de mudança ou problemas relacionados à API, considerados essenciais para rastrear a integridade operacional e os esforços de correção.
Mapa de relacionamento
Fornece uma visão geral hierárquica dos relacionamentos de API com seus componentes, plataformas de gestão, aplicações de negócios e designs, facilitando a compreensão da função da API na arquitetura do sistema mais ampla. Além disso, o fornece a opção de gerenciar relacionamentos de serviço de aplicativos. Consulte Como gerenciar relacionamentos de serviço de aplicações para APIs.
O mapa de relacionamento é um mapa parcial unificado e semelhante ao usado no Espaço do CMDB. Para abrir o mapa unificado de APIs, selecione Abrir mapa completo na seção "Mapa de relacionamento" da página de detalhes da API. Para saber mais, consulte Mapa unificado.
Figura 2. Mapa unificado para APIs
Os nós no mapa representam a API e seus componentes no CMDB, e as linhas representam conexões e relacionamentos entre componentes da API. As conexões ajudam você, por exemplo, a avaliar o impacto de uma mudança em um nó selecionado, mostrando os componentes que estão conectados a ele por relacionamentos e referências. Produtos como Change Management, Incident Management e Event Management se beneficiam dessas informações.
O mapa também mostra a composição dos serviços de aplicações, úteis com produtos como Event Management e Incident Management. Você pode analisar as mudanças históricas.
Os elementos a seguir estão disponíveis no mapa unificado para APIs:
1: Mapa
O mapa exibe a API especificada e suas conexões e relacionamentos. No exemplo, o httpbin.org-v1.1 é o nó inicial, e as linhas representam conexões e relacionamentos com outros componentes. Selecione qualquer nó para exibir detalhes, como serviços de aplicações relacionados e histórico de mudanças.
2: Controles de conteúdo
Pesquise e selecione o nó inicial, especifique o número de níveis de relacionamento para exibição dos serviços de aplicações e recarregue o mapa depois de fazer as mudanças.
Use filtros para limitar os tipos e os tipos de relacionamento exibidos no mapa.
Mostre ou oculte a linha do tempo dos eventos (itens relacionados) da API selecionada
3: Caixa de ferramentas
Use a caixa de ferramentas para controlar diversos aspectos visuais do mapa, como nível de zoom ou modo de layout.
4: Painel lateral contextual
O painel Atributos () lista atributos, como local e status operacional, referentes ao relacionamento ou à API selecionada.
O painel Serviços de aplicações () lista detalhes dos serviços de aplicações associados à API selecionada.
O painel Itens relacionados () mostra itens relacionados, como incidentes ativos ou problemas ativos, da API selecionada.
O painel Mudanças () lista as mudanças, como mudanças no status operacional, da API selecionada.
5: Navegador de minimapa
Defina o nível de zoom ou mova a exibição para uma área de interesse. Selecione o ícone para mostrar ou ocultar o navegador.
6: Linha do tempo
A linha do tempo indica eventos (itens relacionados) como incidentes, problemas e mudanças na API selecionada durante um período especificado. Você pode usar a linha do tempo para visualizar o histórico de mudanças em uma API e como essas mudanças afetam a topologia do CMDB.
) lista atributos, como local e status operacional, referentes ao relacionamento ou à API selecionada.
) lista detalhes dos serviços de aplicações associados à API selecionada.
) mostra itens relacionados, como incidentes ativos ou problemas ativos, da API selecionada.
) lista as mudanças, como mudanças no status operacional, da API selecionada.