Configurar Conector de APIs do Service Graph para AWS API Gateway usando a configuração assistida

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 7 min. de leitura
  • Configure trabalhos de importação agendada para inserir dados AWS API Gateway no seu CMDB.

    Antes de Iniciar

    Importante:
    A menos que haja problemas, use a exibição Central do SGC, pois o método de configuração assistida será descontinuado. Se uma conexão for configurada usando a configuração assistida, a conexão poderá não aparecer na exibição Central do SGC.

    O mecanismo de autenticação usado pelo conector é Tipo de Assinatura da AWS (Técnica de Autenticação HMAC) com o token AWS STS (Security Token Service). Para obter informações sobre permissões, consulte o artigo Conector do Service Graph de API para Gateway de API da AWS - Instruções de configuração [KB1962734] na Base de conhecimento Now Support.

    Dependências e requisitos:
    • A aplicação da Store Componentes comuns de integração para CMDB, que é instalado automaticamente. Veja Componentes comuns de integração para CMDB.
    • O app da Store para os Modelos de classe de IC do CMDB, que é instalado automaticamente. Consulte Modelos de classe de IC do CMDB.
    • O plug-in de licença da Descoberta do ITOM (com.snc.itom.discovery.license). Você deve ativar este plug-in.
    • Plug-in de licenciamento do ITOM (com.snc.itom.license). Consulte Request Discovery.

    Função necessária: administrador

    Procedimento

    1. Use o seletor de aplicações para verificar se o escopo da aplicação está definido para a aplicação Conector de APIs do Service Graph para AWS API Gateway.
      Para obter mais informações, consulte Seletor de aplicações.
    2. Navegar até Tudo > Conectores do Service Graph > Gateway de API da AWS > Configuração.
    3. Na página Configuração assistida, selecione Continuar.
    4. Configure as credenciais de autenticação a fim de enviar solicitações ao AWS API Gateway.
      1. Na seção Configurar conexão e credenciais da página Conector de APIs do Service Graph para AWS API Gateway, selecione Iniciar.
      2. Configure a conexão.
        1. Selecione a tarefa Configurar credenciais de autenticação da AWS.
        2. No campo Nome, insira um nome para a autenticação.

          SGAwsApiCredentials é o nome padrão do alias de credencial. Você pode adicionar várias instâncias AWS API Gateway. No entanto, tente não modificar o alias de conexão padrão.

        3. Insira o ID da chave de acesso e a chave de acesso secreta nos campos ID da chave de acesso e Chave de acesso secreta, respectivamente.

          As chaves de acesso da AWS são credenciais de longo prazo para o usuário do IAM e consistem em duas partes: um ID de chave de acesso e uma chave de acesso secreta. Você deve usar o ID da chave de acesso e a chave de acesso secreta juntos para autenticar as solicitações.

        4. Selecione Atualizar.
        5. Defina a tarefa Configurar credenciais de autenticação da AWS como concluída marcando a caixa de seleção Marcar como concluída e, em seguida, selecione Continuar.
      3. Atualize as propriedades de configuração necessárias para uma instância do AWS API Gateway e teste a conexão.
        1. Selecione a tarefa Configurar e testar detalhes da conta da AWS.
        2. Na seção Conexões do Service Graph, analise e modifique os detalhes da propriedade selecionando uma propriedade na coluna Propriedade da lista relacionada "Propriedades de conexão do Service Graph".
          Você pode configurar as seguintes propriedades:
          AccountId
          Um identificador numérico do ID da conta da AWS.
          CollectionPeriod (dias)
          Duração em dias para coletar dados de uso da API.
          CollectUsageData
          Habilite a coleta de dados de uso para recuperar dados de uso da API ao longo de uma duração especificada.
          IsGovCloud
          Habilite para indicar que a configuração da conexão é para o AWS GovCloud.
          ConfigAggregatorAccountId
          ID da conta da AWS em que o tipo de recurso de agregador no serviço de configuração da AWS foi configurado.
          Regiões
          Uma lista de regiões separadas por vírgulas onde o AWS API Gateway reside.
          Tamanho da partição
          Tamanho da partição para APIs gerenciadas pela AWS se o carregamento paralelo estiver habilitado.

          Aceita um valor numérico maior que zero. Se for deixado em branco, o valor será calculado automaticamente.

          StandaloneAccountId
          O ID de uma conta de membro associada à conta AWS API Gateway.
          ConfigAggregatorName
          O nome do tipo de recurso de agregador no serviço de configuração da AWS.
          ManagementAccountId
          O ID da conta de gestão associada à conta AWS API Gateway.
          ConfigAggregatorRegion
          A região onde reside o tipo de recurso do agregador.
          StsRoleName
          O nome da função presumida do STS da AWSconta usado para consultar a API da Função presumida do STS para obter as credenciais da API.
        3. Selecione Atualizar na seção "Propriedades de conexão do Service Graph".
        4. Teste a conexão selecionando o link relacionado Testar conexão.

          O teste de conexão pode levar alguns minutos. A página é atualizada para mostrar os resultados do teste.

        5. Quando o campo Status estiver definido como Êxito, selecione Atualizar.

          Se algum dos testes apresentar erros, siga as sugestões de correção.

        6. Defina a tarefa Configurar e testar detalhes da conta da AWS como concluída marcando a caixa de seleção Marcar como concluída e, em seguida, selecione Continuar.
    5. Opcional: Faça a integração a várias instâncias do AWS API Gateway.
      1. Na seção Adicionar várias instâncias da página do Conector de APIs do Service Graph para AWS API Gateway, selecione Iniciar.
      2. Habilite a criação de fontes de dados para a nova conexão do AWS API Gateway.
        1. Verifique se você tem permissões de edição para a tabela "Fonte de dados" [sys_data_source].
        2. Selecione a tarefa Atualizar acesso à fonte de dados.
        3. Para editar o registro, selecione o escopo da aplicação Global no seletor de aplicações.
        4. Na lista relacionada de acesso à aplicação no formulário de fonte de dados que abre em uma nova guia, selecione as caixas de seleção Pode criar, Pode atualizar e Pode excluir.
        5. Selecione Atualizar.
        6. Selecione o escopo da aplicação Conector de APIs do Service Graph para AWS API Gateway no seletor de aplicações.
        7. Defina a tarefa Atualizar acesso à fonte de dados como concluída marcando a caixa de seleção Marcar como concluída e, em seguida, selecione Continuar.
      3. Habilite a criação de um trabalho de importação agendada para a nova conexão do AWS API Gateway.
        1. Verifique se você tem permissões de edição para a tabela Importação Programada de Dados [scheduled_import_set].
        2. Selecione a tarefa Atualizar acesso à importação agendada de dados.
        3. Para editar o registro, selecione o escopo da aplicação Global no seletor de aplicações.
        4. Na lista relacionada "Acesso à aplicação" do formulário "Importação agendada de dados", marque as caixas de seleção Pode criar, Pode atualizar e Pode excluir.
        5. Selecione Atualizar.
        6. Selecione o escopo da aplicação Conector de APIs do Service Graph para AWS API Gateway no seletor de aplicações.
        7. Defina a tarefa Atualizar importação agendada de dados como concluída marcando a caixa de seleção Marcar como concluída e, em seguida, selecione Continuar.
      4. Limpe o cache nas tabelas "Fonte de dados" [sys_data_source] e "Importações agendadas de dados" [scheduled_import_set].
        1. Selecione a tarefa Limpar cache das tabelas "Fontes de dados" e "Importações agendadas de dados".
        2. Para editar o registro, selecione o escopo da aplicação Global no seletor de aplicações.
        3. No campo Executar Script, insira o código a seguir:
          GlideTableManager.invalidateTable("sys_data_source");
          GlideCacheManager.flushTable("sys_data_source");
          GlideTableManager.invalidateTable("scheduled_import_set");
          GlideCacheManager.flushTable("scheduled_import_set");
          GlideTableManager.invalidateTable("sys_db_object");
          GlideCacheManager.flushTable("sys_db_object");
        4. Selecione Executar script.
        5. Selecione o escopo da aplicação Conector de APIs do Service Graph para AWS API Gateway no seletor de aplicações.
        6. Defina a tarefa Limpar cache das tabelas "Fontes de dados" e "Importações agendadas de dados" como concluída clicando em Marcar como concluído.
      5. Adicione outra conexão para a nova instância do AWS API Gateway.
        1. Use o seletor de aplicações para verificar se o escopo da aplicação está definido para a aplicação Conector de APIs do Service Graph para AWS API Gateway.
        2. Selecione a tarefa Adicionar outras conexões e, em seguida, Clicar aqui.
        3. Na página "Conexões" que abre em outra guia do navegador, selecione Adicionar conexão.
        4. Na janela Criar conexão, preencha o nome da conexão, a chave de acesso e os detalhes da chave secreta.
        5. Selecione Criar conexão.
        6. Feche o Workflow Studio e volte à guia da configuração assistida.
        7. Defina a tarefa Adicionar outra conexão como concluída marcando a caixa de seleção Marcar como concluída e, em seguida, selecione Continuar.
      6. Atualize as propriedades de configuração necessárias para a nova conexão do AWS API Gateway e teste a conexão.
        1. Selecione a tarefa Testar novas conexões.
        2. Selecione o registro de conexão que você criou na etapa 5.e.
        3. Teste a conexão selecionando o link relacionado Testar conexão.

          O teste de conexão pode levar alguns minutos. A página é atualizada para mostrar os resultados do teste.

        4. Quando o campo Status estiver definido como Êxito, selecione Atualizar.

          Se algum dos testes apresentar algum erro, siga as sugestões de correção.

        5. Defina a tarefa Testar novas conexões como concluída marcando a caixa de seleção Marcar como concluída e, em seguida, selecione Continuar.
    6. Configure o trabalho agendado para a importação de dados do AWS API Gateway.
      1. Na seção Configurar trabalhos de importação agendada da página Conector de APIs do Service Graph para AWS API Gateway, selecione Iniciar.
      2. Selecione o trabalho agendado SGA-AWS-API-Gateway-Managed-API-REST.
        Caso haja várias instâncias, selecione o trabalho agendado para a fonte de dados SGA-AWS-API-Gateway-Managed-API-REST.
      3. No formulário Importação agendada de dados, verifique os valores de campos do trabalho agendado.

        Para obter mais informações, consulte Schedule a data import.

      4. Marque a caixa de seleção Ativa para ativar o trabalho agendado para a fonte de dados SGA-AWS-API-Gateway-Managed-API-REST.
      5. Selecione Atualizar.
      6. Defina a tarefa Configurar trabalhos de importação agendada como concluída marcando a caixa de seleção Marcar como concluída e, em seguida, selecione Continuar.
    7. Na página Conector de APIs do Service Graph para AWS API Gateway, selecione Concluído para salvar as mudanças.
    8. Na caixa de diálogo "Concluir configuração", selecione Concluir para concluir a configuração.
    9. Na caixa de mensagem que é exibida, selecione Concluído.