ガイド付きセットアップを使用して AWS API Gateway の API サービスグラフコネクタ を構成します

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間:11分
  • AWS API ゲートウェイ データを CMDB にプルするようにスケジュール済みインポートジョブを設定します。

    始める前に

    重要:
    ガイド付きセットアップ方法は廃止されるため、問題がない限り、 SGC セントラル ビューを使用してください。ガイド付きセットアップを使用して接続を構成すると、接続が SGC セントラル ビューに表示されないことがあります。

    コネクタで使用される認証メカニズムは、AWS セキュリティトークンサービス (STS) のトークンを使用する AWS 署名タイプ (HMAC 認証手法) です。権限の詳細については、Now Supportナレッジベースの記事「API Service Graph Connector for AWS API Gateway - Setup Instructions (AWS API Gateway の API サービスグラフコネクタ - セットアップ手順) [KB1962734]」を参照してください。

    依存関係と要件:
    • 自動的にインストールされる CMDB 共通統合ストアアプリ。「Integration Commons for CMDB」を参照してください。
    • 自動的にインストールされる CMDB CI クラスモデルストアアプリ。「CMDB CI クラスモデル」を参照してください。
    • ITOM ディスカバリーライセンスプラグイン (com.snc.itom.discovery.license)。このプラグインを有効にする必要があります。
    • ITOM Licensing プラグイン (com.snc.itom.license)。「Request Discovery」を参照してください。

    必要なロール:admin

    手順

    1. アプリケーションピッカーを使用して、アプリケーションスコープを AWS API Gateway の API サービスグラフコネクタ アプリケーションに設定します。
      詳細については、「アプリケーションピッカー」を参照してください。
    2. 次のように移動する。 All (すべて) > Service Graph Connector > AWS API Gateway > セットアップ.
    3. [ガイド付きセットアップ] ページで、[ 続行] を選択します。
    4. AWS API ゲートウェイ に要求を送信するための認証情報を構成します。
      1. [AWS API Gateway の API サービスグラフコネクタ] ページの [接続と認証情報の構成] セクションで、[開始] を選択します。
      2. 接続を構成します。
        1. タスク [AWS 認証情報を構成する (Configure AWS authentication credentials)] を選択します。
        2. [名前] フィールドに、認証の名前を入力します。

          SGAwsApiCredentials は、デフォルトの認証情報エイリアス名です。複数の AWS API ゲートウェイ インスタンスを追加できます。ただし、デフォルトの接続エイリアスは変更しないでください。

        3. [アクセスキー ID] フィールドと [秘密アクセスキー] フィールドに、それぞれアクセスキー ID と秘密アクセスキーを入力します。

          AWS アクセスキーは IAM ユーザーの長期的な認証情報であり、アクセスキー ID と秘密アクセスキーの 2 つの部分で構成されています。要求を認証するには、アクセスキー ID と秘密アクセスキーの両方を一緒に使用する必要があります。

        4. [更新] を選択します。
        5. [完了としてマーク] チェックボックスをオンにして [AWS 認証情報を構成する (Configure AWS authentication credentials)] タスクを完了に設定し、[続行] を選択します。
      3. AWS API ゲートウェイ インスタンスで必要な構成プロパティを更新し、接続をテストします。
        1. [AWS アカウントの詳細の構成とテスト (Configure and Test AWS Account Details)] タスクを選択します。
        2. [サービスグラフ接続] セクションで、[サービスグラフ接続のプロパティ] 関連リストの [プロパティ] 列からプロパティを選択して、プロパティの詳細を確認して変更します。
          以下のプロパティを構成することができます。
          AccountId
          AWS アカウント ID の数値識別子。
          CollectionPeriod(日数)
          API 使用状況データを収集する期間 (日数)。
          使用状況データの収集
          指定した期間の API 使用状況データを取得するには、使用状況データ収集を有効にします。
          IsGovCloud
          接続セットアップが AWS GovCloud 用であることを示す場合に有効にします。
          ConfigAggregatorAccountId
          AWS Config サービスのアグリゲーターリソースタイプが構成されている AWS アカウント ID。
          Region(s)
          AWS API ゲートウェイ が存在するリージョンをカンマで区切ったリスト。
          パーティションサイズ
          並列ロードが有効になっている場合の AWS マネージド API のパーティションサイズ。

          0 より大きい数値を受け入れます。空のままにすると、値が自動的に計算されます。

          StandaloneAccountId
          AWS API ゲートウェイアカウントに関連付けられたメンバーアカウントの ID。
          ConfigAggregatorName
          AWS Config サービスのアグリゲーターリソースタイプの名前。
          ManagementAccountId
          AWS API ゲートウェイアカウントに関連付けられた管理アカウント ID。
          コンフィグアグリゲーターリージョン
          アグリゲーターリソースタイプが存在するリージョン。
          StsRoleName
          STS ロール想定 API のクエリを実行して API 認証情報を取得するために使用する AWS アカウントの STS 想定ロール名。
        3. [サービスグラフ接続のプロパティ] セクションで [更新] を選択します。
        4. [テスト接続] 関連リンクを選択して、接続をテストします。

          接続のテストには少し時間がかかる場合があります。ページが更新され、テスト結果が表示されます。

        5. [ステータス] フィールドが [成功] に設定されている場合は、[更新] を選択します。

          いずれかのテストでエラーが発生した場合は、修正の提案に従ってください。

        6. [完了としてマーク] チェックボックスをオンにして、[AWS アカウントの詳細の構成とテスト (Configure and Test AWS Account Details)] タスクを完了に設定し、[続行] を選択します。
    5. オプション: 複数の AWS API ゲートウェイ インスタンスと統合します。
      1. [AWS API Gateway の API サービスグラフコネクタ] ページの [複数のインスタンスを追加] セクションで [開始] を選択します。
      2. 新しい AWS API ゲートウェイ 接続のデータソースの作成を有効にします。
        1. データソース [sys_data_source] テーブルの編集権限があることを確認してください。
        2. [データソースアクセスを更新] タスクを選択します。
        3. レコードを編集するには、アプリケーションピッカーから [グローバル] アプリケーションスコープを選択します。
        4. 新しいタブで表示される [データソース] フォームの [アプリケーションのアクセス] 関連リストで、[作成可能][更新可能]、および [削除可能] チェックボックスをオンにします。
        5. [更新] を選択します。
        6. アプリケーションピッカーから、AWS API Gateway の API サービスグラフコネクタアプリケーションスコープを選択します。
        7. [完了としてマーク] チェックボックスをオンにして、[データソースアクセスを更新] タスクを完了に設定し、[続行] を選択します。
      3. 新しい AWS API ゲートウェイ接続のスケジュール済みインポートジョブの作成を有効にします。
        1. 予定されているデータインポート [scheduled_import_set] テーブルの編集権限があることを確認してください。
        2. [データソースアクセスを更新 (Update Data Scheduled Import Access )] タスクを選択します。
        3. レコードを編集するには、アプリケーションピッカーから [グローバル] アプリケーションスコープを選択します。
        4. [予定されているデータインポート] フォームの [アプリケーションのアクセス] 関連リストで、[作成可能][更新可能]、および [削除可能] チェックボックスをオンにします。
        5. [更新] を選択します。
        6. アプリケーションピッカーから、AWS API Gateway の API サービスグラフコネクタアプリケーションスコープを選択します。
        7. [完了としてマーク] チェックボックスをオンにして、[データの予定されているインポートアクセスを更新 (Update Data Scheduled Import Access)] タスクを完了に設定し、[続行] を選択します。
      4. データソース [sys_data_source] テーブルと予定されているデータインポート [scheduled_import_set] テーブルのキャッシュをクリアします。
        1. [データソースおよび予定されているデータインポートテーブルのキャッシュをクリア] タスクを選択します。
        2. レコードを編集するには、アプリケーションピッカーから [グローバル] アプリケーションスコープを選択します。
        3. [スクリプトを実行] フィールドに次のコードを入力します。
          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. [スクリプトを実行] を選択します。
        5. アプリケーションピッカーから、AWS API Gateway の API サービスグラフコネクタアプリケーションスコープを選択します。
        6. [データソースおよび予定されているデータインポートテーブルのキャッシュをクリア] タスクで、[完了としてマーク] を選択して、完了に設定します。
      5. 新しい AWS API ゲートウェイ インスタンスに別の接続を追加します。
        1. アプリケーションピッカーを使用して、アプリケーションスコープを AWS API Gateway の API サービスグラフコネクタ アプリケーションに設定します。
        2. [別の接続を追加] タスクを選択し、[ここをクリック] を選択します。
        3. 新しいブラウザタブで開かれた [接続] ページで、[接続を追加] を選択します。
        4. [接続を作成] ウィンドウで、接続名、アクセスキー、および秘密キーの詳細を入力します。
        5. [接続を作成] を選択します。
        6. ワークフロースタジオを閉じて、ガイド付きセットアップタブに戻ります。
        7. [完了としてマーク] チェックボックスをオンにして、[別の接続を追加 (Add Another Connections)] タスクを完了に設定し、[続行] を選択します。
      6. 新しい AWS API ゲートウェイ 接続に必要な構成プロパティを更新し、接続をテストします。
        1. [新しい接続をテスト] タスクを選択します。
        2. ステップ 5.e で作成した接続レコードを選択します。
        3. [テスト接続] 関連リンクを選択して、接続をテストします。

          接続のテストには少し時間がかかる場合があります。ページが更新され、テスト結果が表示されます。

        4. [ステータス] フィールドが [成功] に設定されている場合は、[更新] を選択します。

          いずれかのテストでエラーが発生した場合は、修正の提案に従ってください。

        5. [完了としてマーク] チェックボックスをオンにして、[新しい接続をテスト] タスクを完了に設定し、[続行] を選択します。
    6. AWS API ゲートウェイ データをインポートするためのスケジュール済みジョブを構成します。
      1. [AWS API Gateway の API サービスグラフコネクタ] ページの [スケジュール済みインポートジョブを設定 (Set up Scheduled Import Jobs)] セクションで、[開始] を選択します。
      2. SGA-AWS-API-Gateway-Managed-API-REST スケジュール済みジョブを選択します。
        複数のインスタンスの場合は、SGA-AWS-API-Gateway-Managed-API-REST データソースのスケジュール済みジョブを選択します。
      3. [スケジュール設定済みデータインポート(Scheduled Data Import)] フォームで、スケジュール済みジョブのフィールド値を確認します。

        詳細については、「Schedule a data import」を参照してください。

      4. [アクティブ] チェックボックスをオンにして、SGA-AWS-API-Gateway-Managed-API-REST データソースのスケジュール済みジョブをアクティブ化します。
      5. [更新] を選択します。
      6. [完了としてマーク] チェックボックスをオンにして、[スケジュール済みインポートジョブを設定 (Set up Scheduled Import Jobs)] タスクを完了に設定し、[続行] を選択します。
    7. [AWS API Gateway の API サービスグラフコネクタ] ページで、[完了] を選択して変更を保存します。
    8. [セットアップの完了] ダイアログボックスで、[完了] を選択してセットアップを完了します。
    9. 表示されるメッセージ ボックスで、 [完了] を選択します。