Konfigurieren Sie API Service Graph Connector für AWS – API-Gateway mithilfe des geführten Setups

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 6 Minuten Lesedauer
  • Richten Sie geplante Importaufträge ein, um AWS API Gateway -Daten in Ihre CMDBabzurufen.

    Vorbereitungen

    Wichtig:
    Sofern keine Probleme auftreten, verwenden Sie die Ansicht SGC Central, da die Methode des geführten Setups veraltet ist. Wenn eine Verbindung mithilfe des geführten Setups konfiguriert wird, wird die Verbindung möglicherweise nicht in der Ansicht SGC Central angezeigt.

    Der vom Connector verwendete Authentifizierungsmechanismus ist der AWS-Signaturtyp (HMAC-Authentifizierungstechnik) mit dem AWS Security Token Service-Token (STS). Informationen zu Berechtigungen finden Sie im Artikel API Service Graph Connector für AWS API Gateway – Setupanweisungen [KB1962734] in der Knowledge Base Now Support.

    Abhängigkeiten und Anforderungen:
    • Die Store App Integration Common for CMDB (Integration Common für CMDB), die automatisch installiert wird. Siehe Gemeinsame Komponenten für CMDB-Integrationen.
    • Die Store-App CMDB CI-Klassenmodelle, die automatisch installiert wird. Weitere Informationen finden Sie unter CMDB CI-Klassenmodelle.
    • Plugin „ITOM Discovery License“ (com.snc.itom.discovery.license). Sie müssen dieses Plugin aktivieren.
    • ITOM-Lizenzierungs-Plugin (com.snc.itom.license). Weitere Informationen finden Sie unter Request Discovery.

    Erforderliche Rolle: Administrator

    Prozedur

    1. Stellen Sie mithilfe der Anwendungsauswahl sicher, dass der Anwendungsbereich auf die Anwendung API Service Graph Connector für AWS – API-Gateway festgelegt ist.
      Weitere Informationen finden Sie unter Anwendungsauswahl.
    2. Navigieren zu Alle > Service Graph Connectors > AWS API-Gateway > Setup.
    3. Wählen Sie auf der Seite des geführten Setups Fortsetzenaus.
    4. Konfigurieren Sie die Anmeldeinformationen für die Authentifizierung, um Anforderungen an AWS API Gatewayzu senden.
      1. Wählen Sie auf der Seite API Service Graph Connector für AWS – API-Gateway im Abschnitt „Verbindung und Anmeldeinformationen konfigurieren“Startenaus.
      2. Konfigurieren Sie die Verbindung.
        1. Wählen Sie die Aufgabe Anmeldeinformationen für AWS-Authentifizierung konfigurieren aus.
        2. Geben Sie im Feld Name einen Namen für die Authentifizierung ein.

          „SGAwsApiCredentials“ ist der Standardaliasname für Anmeldeinformationen. Sie können mehrere AWS API Gateway -Instanzen hinzufügen. Versuchen Sie jedoch nicht, den Standardverbindungsalias zu ändern.

        3. Geben Sie die Zugriffsschlüssel-ID und den geheimen Zugriffsschlüssel in die Felder Zugriffsschlüssel-ID und Geheimer Zugriffsschlüssel ein.

          Die AWS-Zugriffsschlüssel sind langfristige Anmeldeinformationen für den IAM-Benutzer und bestehen aus zwei Teilen: einer Zugriffsschlüssel-ID und einem geheimen Zugriffsschlüssel. Sie müssen die Zugriffsschlüssel-ID und den geheimen Zugriffsschlüssel zusammen verwenden, um Anforderungen zu authentifizieren.

        4. Wählen Sie Aktualisieren.
        5. Legen Sie die Aufgabe Anmeldeinformationen für die AWS-Authentifizierung konfigurieren auf den Abschluss fest, indem Sie das Kontrollkästchen Als abgeschlossen markieren aktivieren und anschließend Fortfahrenwählen.
      3. Aktualisieren Sie die erforderlichen Konfigurationseigenschaften für eine Instanz AWS API Gateway, und testen Sie die Verbindung.
        1. Wählen Sie die Aufgabe „AWS-Account-Details konfigurieren und testen“ aus.
        2. Überprüfen und ändern Sie im Abschnitt Service Graph-Verbindungen die Eigenschaftsdetails, indem Sie in der zugehörigen Liste Service Graph-Verbindungseigenschaften in der Spalte Eigenschaft eine Eigenschaft auswählen.
          Sie können die folgenden Eigenschaften konfigurieren:
          AccountId
          Ein numerischer Bezeichner der Account-ID AWS.
          CollectionPeriod (Tage)
          Dauer der Erfassung von API-Nutzungsdaten in Tagen.
          SammlungNutzungsdaten
          Aktivieren Sie die Nutzungsdatenerfassung, um API-Nutzungsdaten über einen angegebenen Zeitraum abzurufen.
          IsGovCloud
          Aktivieren Sie diese Option, um anzugeben, dass das Verbindungs-Setup für AWS GovCloud gilt.
          ConfigAggregatorAccountId
          AWS-Account-ID, in der der Aggregator-Ressourcentyp im AWS Config-Service konfiguriert wurde.
          Region(en)
          Eine durch Kommas getrennte Liste von Regionen, in denen sich AWS API Gateway befindet.
          Partitionsgröße
          Partitionsgröße für von AWS verwaltete APIs, wenn paralleles Laden aktiviert ist.

          Akzeptiert einen numerischen Wert größer als null. Wenn es leer gelassen wird, wird der Wert automatisch berechnet.

          EigenständigeAccountId
          Die ID eines Mitgliedsaccounts, der dem Account AWS API Gateway zugeordnet ist.
          ConfigAggregatorName
          Der Name des Aggregator-Ressourcentyps im AWS Config-Service.
          ManagementAccountId
          Die Verwaltungs-Account-ID, die dem Account AWS API Gateway zugeordnet ist.
          ConfigAggregatorRegion
          Die Region, in der sich der Aggregator-Ressourcentyp befindet.
          STSRollenname
          Der STS-Rollenübernahmename des AWS Accounts, der für die Abfrage der STS-Rollenübernahme -API zum Abrufen der API-Anmeldeinformationen verwendet wird.
        3. Wählen Sie im Abschnitt Service Graph-Verbindungseigenschaften die Option Aktualisieren aus.
        4. Testen Sie die Verbindung, indem Sie den zugehörigen Link Test Connection (Verbindung testen) auswählen.

          Das Testen der Verbindung kann einige Minuten dauern. Die Seite wird aktualisiert, um die Testergebnisse anzuzeigen.

        5. Wenn das Feld Status auf Erfolgfestgelegt ist, wählen Sie Aktualisieren.

          Wenn bei einem der Tests Fehler auftreten, befolgen Sie die Vorschläge zur Korrektur.

        6. Legen Sie die Aufgabe Konfigurieren und Testen von AWS-Account-Details auf Abgeschlossen fest, indem Sie das Kontrollkästchen Als abgeschlossen markieren aktivieren und dann Fortfahrenwählen.
    5. Wahlweise: Integration mit mehreren AWS API Gateway -Instanzen.
      1. Wählen Sie auf der Seite API Service Graph Connector für AWS – API-Gateway im Abschnitt „Mehrere Instanzen hinzufügen“ Startenaus.
      2. Aktivieren Sie die Erstellung von Datenquellen für die neue AWS API Gateway -Verbindung.
        1. Vergewissern Sie sich, dass Sie über Bearbeitungsberechtigungen für die Tabelle „Datenquelle“ [sys_data_source] verfügen.
        2. Wählen Sie die Aufgabe Datenquellenzugriff aktualisieren aus.
        3. Um den Datensatz zu bearbeiten, wählen Sie in der Anwendungsauswahl den Anwendungsbereich Global aus.
        4. Aktivieren Sie in der zugehörigen Liste „Anwendungszugriff“ des Formulars „Datenquelle“, das auf einer neuen Registerkarte geöffnet wird, die Kontrollkästchen „ Kann erstellen“, „Kann aktualisieren“ und „Kann löschen“.
        5. Wählen Sie Aktualisieren.
        6. Wählen Sie in der Anwendungsauswahl den Anwendungsbereich API Service Graph Connector für AWS – API-Gateway aus.
        7. Legen Sie die Aufgabe „Datenquellenzugriff aktualisieren“ auf „Abgeschlossen“ fest, indem Sie das Kontrollkästchen „Als abgeschlossen markieren“ aktivieren, und wählen Sie dann Weiteraus.
      3. Aktivieren Sie die Erstellung eines geplanten Importauftrags für die neue Verbindung AWS API Gateway.
        1. Vergewissern Sie sich, dass Sie über Bearbeitungsberechtigungen für die Tabelle „Geplanter Datenimport“ [schedule_import_set] verfügen.
        2. Wählen Sie die Aufgabe Zugriff für geplanten Datenimport aktualisieren aus.
        3. Um den Datensatz zu bearbeiten, wählen Sie in der Anwendungsauswahl den Anwendungsbereich Global aus.
        4. Aktivieren Sie in der zugehörigen Liste „Anwendungszugriff“ des Formulars „Geplanter Datenimport“ die Kontrollkästchen „ Kann erstellen“, „Kann aktualisieren“ und „Kann löschen“.
        5. Wählen Sie Aktualisieren.
        6. Wählen Sie in der Anwendungsauswahl den Anwendungsbereich API Service Graph Connector für AWS – API-Gateway aus.
        7. Legen Sie die Aufgabe „Zugriff für geplanten Datenimport aktualisieren“ auf „Abgeschlossen“ fest, indem Sie das Kontrollkästchen Als abgeschlossen markieren aktivieren und anschließend Fortfahrenwählen.
      4. Leeren Sie den Cache in den Tabellen „Datenquelle“ [sys_data_source] und „Geplante Datenimporte“ [schedule_import_set].
        1. Wählen Sie die Aufgabe Cache für Datenquellen und geplante Datenimporte leeren aus.
        2. Um den Datensatz zu bearbeiten, wählen Sie in der Anwendungsauswahl den Anwendungsbereich Global aus.
        3. Geben Sie im Feld Skript ausführen den folgenden Code ein:
          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. Wählen Sie Skript ausführenaus.
        5. Wählen Sie in der Anwendungsauswahl den Anwendungsbereich API Service Graph Connector für AWS – API-Gateway aus.
        6. Legen Sie die Aufgabe Cache für Datenquellen und geplante Datenimporte leeren auf den Abschluss fest, indem Sie Als abgeschlossen markierenwählen.
      5. Fügen Sie eine weitere Verbindung für die neue Instanz AWS API Gateway hinzu.
        1. Stellen Sie mithilfe der Anwendungsauswahl sicher, dass der Anwendungsbereich auf die Anwendung API Service Graph Connector für AWS – API-Gateway festgelegt ist.
        2. Wählen Sie die Aufgabe Weitere Verbindungen hinzufügen und dann Klicken Sie hieraus.
        3. Wählen Sie auf der Seite „Verbindungen“, die in einer anderen Browserregisterkarte geöffnet wird, Verbindung hinzufügen.
        4. Füllen Sie im Fenster Verbindung erstellen den Verbindungsnamen, den Zugriffsschlüssel und den geheimen Schlüssel aus.
        5. Wählen Sie Verbindung erstellen aus.
        6. Schließen Sie Workflow-Studio, und kehren Sie zur Registerkarte des geführten Setups zurück.
        7. Setzen Sie die Aufgabe Weitere Verbindungen hinzufügen auf den Abschluss, indem Sie das Kontrollkästchen Als abgeschlossen markieren aktivieren, und wählen Sie dann Weiteraus.
      6. Aktualisieren Sie die erforderlichen Konfigurationseigenschaften für die neue AWS API Gateway -Verbindung, und testen Sie die Verbindung.
        1. Wählen Sie die Aufgabe Neue Verbindungen testen aus.
        2. Wählen Sie den Verbindungsdatensatz aus, den Sie in Schritt 5.eerstellt haben.
        3. Testen Sie die Verbindung, indem Sie den zugehörigen Link Test Connection (Verbindung testen) auswählen.

          Das Testen der Verbindung kann einige Minuten dauern. Die Seite wird aktualisiert, um die Testergebnisse anzuzeigen.

        4. Wenn das Feld Status auf Erfolgfestgelegt ist, wählen Sie Aktualisieren.

          Wenn bei einem der Tests Fehler auftreten, befolgen Sie die Vorschläge zur Korrektur.

        5. Legen Sie die Aufgabe Neue Verbindungen testen auf den Abschluss fest, indem Sie das Kontrollkästchen Als abgeschlossen markieren aktivieren und dann Fortfahrenwählen.
    6. Konfigurieren Sie die geplante Aufgabe für den Import von AWS API Gateway -Daten.
      1. Wählen Sie im Abschnitt Geplante Importaufträge einrichten der Seite API Service Graph Connector für AWS – API-GatewayStarten aus.
      2. Wählen Sie die geplante Aufgabe SGA-AWS-API-Gateway-Managed-API-REST aus.
        Wählen Sie bei mehreren Instanzen die geplante Aufgabe für die Datenquelle SGA-AWS-API-Gateway-Managed-API-REST aus.
      3. Überprüfen Sie im Formular „Geplanter Datenimport“ die Feldwerte für die geplante Aufgabe.

        Weitere Informationen finden Sie unter Schedule a data import.

      4. Aktivieren Sie das Kontrollkästchen Aktiv, um die geplante Aufgabe für die Datenquelle SGA-AWS-API-Gateway-Managed-API-REST zu aktivieren.
      5. Wählen Sie Aktualisieren.
      6. Legen Sie die Aufgabe Geplante Importaufträge einrichten auf den Abschluss fest, indem Sie das Kontrollkästchen Als abgeschlossen markieren aktivieren und anschließend Fortfahrenwählen.
    7. Wählen Sie auf der Seite API Service Graph Connector für AWS – API-Gateway die Option Abschließen aus, um Ihre Änderungen zu speichern.
    8. Wählen Sie im Dialogfeld Setup abschließen die Option Abgeschlossen aus, um das Setup abzuschließen.
    9. Wählen Sie im angezeigten Meldungsfeld Fertig aus.