クラウドコンピューティングデバイスのクラウド REST クエリを定義します

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：4分

    • ディスカバリーパターンの作成または変更の一環として、[クラウド REST クエリ (Cloud REST Query)] 操作によって、Microsoft Azure や Amazon Web サービスなどの PaaS (Platform as a Service) タイプの構成アイテム (CI) から情報を抽出できます。

    始める前に

    • 以下の操作を実行して、[クラウド REST クエリ (Cloud REST Query)] 操作の対象となる CI のオペレーティングシステムで論理データセンターの OS タイプ [cmdb_ci_logical_datacenter] が拡張されていることを確認します。
      1. 移動先 パターンデザイナー > ディスカバリーパターン.
      2. 関連するパターンをダブルクリックして、パターンデザイナーで開きます。
      3. [基本] タブをクリックします。
      4. この CI のオペレーティングシステムを書き留めます。
      5. 移動先 システム定義 > テーブル.
      6. 検索フィールドを [ラベル] に設定し、パターンの [基本] タブに記されているとおりにオペレーティングシステムの名前を入力します。
      7. リストからオペレーティングシステムを見つけ、ロジカルデータセンターが [拡張テーブル] 列に表示されていることを確認します。

    • 関連するパターンステップに移動します。

      1. パターンフォームで、ディスカバリー の関連する識別セクションを選択します。

        または、サービスマッピング の関連する識別セクションまたは接続セクションを選択します。

      2. 関連するパターンステップを選択するか、[ステップを上に追加 (Add a step above)] アイコンをクリックしてステップを追加します。

    プログラミングの基礎知識が望ましいです。

    必要なロール：pd_admin

    このタスクについて

    PaaS CI のディスカバリーに使用するパターンで [クラウド REST クエリ (Cloud REST Query)] 操作を展開します。この Java スクリプトベースのカスタム操作は、ServiceNow Storeからバージョン 1.0.24 以降のパターンをダウンロードした後でのみ利用可能になります。この操作は、ベースシステムで利用可能な [クラウド REST コール (Cloud REST Call)] 操作の代わりに実行します。

    [クラウド REST クエリ (Cloud REST Query)] 操作でクエリするデバイスに対応したクエリ構文を入手するには、メーカーから提供されている API 関連の公式ドキュメントを参照してください。例：

    手順

    1. [操作] リストから [クラウド REST クエリ (Cloud REST Query)] を選択します。
    2. 必要に応じてクエリーパラメーターを定義します。
      注:
      この操作をカスタマイズした場合は、クエリパラメーターが異なる場合があります。
      フィールド 説明
      URL Microsoft Azure または Amazon Web Services の公式ドキュメントの説明に従って URL を指定します。

      変数を使用できます。また、特定のフィールドの値を表形式変数で入力することもできます。
      手法

      メソッドの値を、「GET」のようなすべて大文字の文字列で入力します。サポートされているメソッドは、次のとおりです。

      • GET
      • POST
      • PUT

      詳細については、関連する API ガイドを参照してください。API ドキュメントに HTTP クエリメソッドが明確に記載されていない場合は、GET メソッドを使用します。
      本文 (オプション) 要求本文を文字列として入力します。

      文字列に引用符が含まれている場合は、引用符の前に円記号を使用して、文字列が引用符で終わっていないことを示します。
      ヘッダー (オプション) 関連する API ドキュメントで、HTTP ヘッダーの送信が必須であると述べられている場合は、該当するヘッダーを次の形式で入力します：

      Header_name1:header_value1,header_name2:header_value2

      たとえば、「Content-Type:xml」と入力します。
      書式設定済み JSON 形式で記述されているかどうか
    3. コマンド出力全体を変数として保存するには、[解析を定義] リストから [なし] を選択し、変数を定義します。
    4. [解析を定義] リストから解析戦略を選択します。
    5. デバッグモードで作業している場合は、次のように解析基準を定義します。
      1. [操作を実行] をクリックして、[出力] ペインで結果を確認します。
      2. [出力] ペインで、変数に含めるテキストまたは記号をマークします。
      3. 変数名ボックスに、新しい変数の名前を入力します (例：「process_name」)。

        [出力] ペインでマークされた文字列の変数名の定義
      4. Enter キーを押します。
        新しい変数が [変数] ペインに追加されます。
    6. デバッグモードで作業していない場合は、次のように解析基準を定義します。
      1. [変数] ペインで、[変数を追加] をクリックし、新しい変数の名前を入力します。
      2. [詳細] アイコンをクリックします。

        詳細変数ペインの表示
      3. [列ラベルを追加] をクリックします。
      4. 解析クエリーを入力します。
      5. 区切り文字の値を入力します。
      6. 位置の値を入力します。
    7. 結果が見つからない場合は、[終了] を選択してディスカバリーを停止します。

    例

    この操作の使用場所 対象アイテム
    階層 アプリケーション
    CI タイプ クラウドオブジェクトストレージ [cmdb_ci_cloud_object_storage]
    パターン Amazon AWS S3
    セクション AWS S3 の識別
    ステップ番号とステップ名 3. リストバケット

    クラウド REST クエリ操作

    [クラウド REST クエリ (Cloud REST Query)] 操作により、AWS バケット、その名前、および作成日に関する情報を抽出します。