Qualys REST メッセージ

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:5分
  • Qualys REST メッセージは、コンプライアンスデータを取得するために Qualys API の呼び出しに使用されます。

    次の REST メッセージはベースシステムに付属しています。

    Qualys PC ポリシー (Qualys PC Policies) の REST メッセージ

    Qualys PC ポリシー (Qualys PC Policies) の REST メッセージは、Qualys からポリシーデータを取得します。REST メッセージメソッドレコードを変更すると、ポリシー情報を取得するための Qualys への要求が影響を受けます。

    表 : 1. Qualys PC ポリシー (Qualys PC Policies) の REST メッセージのパラメーター
    パラメーター名 説明
    action リスト 要求された操作のタイプを示します。

    必要なパラメーター。

    details すべて

    取得されたポリシーの詳細レベルを示します。

    要件に応じて変更しても安全です。

    Qualys PC コントロール (Qualys PC Controls) の REST メッセージ

    Qualys PC コントロール (Qualys PC Controls) の REST メッセージは、Qualys からさまざまなコントロール ID のコンプライアンスコントロール情報を取得します。

    表 : 2. Qualys PC コントロール (Qualys PC Controls) の REST メッセージのパラメーター
    パラメーター名 説明
    action リスト 要求された操作のタイプを示します。

    必要なパラメーター。

    details すべて

    取得されたコントロールの詳細レベルを示します。

    要件に応じて変更しても安全です。

    Qualys PC ポリシーの詳細 (Qualys PC Policies Detail) の REST メッセージ

    Qualys PC ポリシーの詳細 (Qualys PC Policies Detail) の REST メッセージは、テクノロジーやセクションなどの完全なポリシーの詳細を取得します。

    表 : 3. Qualys PC ポリシーの詳細 (Qualys PC Policies Detail) の REST メッセージのパラメーター
    パラメーター 説明
    action リスト 要求されている操作のタイプを示します。

    必要なパラメーター。

    show_user_controls ブーリアン
    • XML 出力にユーザー定義コントロール (UDC) を含めるには、1 に設定します。
    • 指定しない場合、UDC は含まれません。

    このパラメーターはオプションです。要件に応じて変更しても安全です。

    show_appendix ブーリアン

    (オプション) XML 出力に付録セクションを表示するには、1 に設定します。指定しない場合は です。

    Qualys PC 結果 (Qualys PC Results) の REST メッセージ

    Qualys PC 結果 (Qualys PC Results) の REST メッセージは、Qualys からコンプライアンス体制レコードを取得します。

    表 : 4. Qualys PC 結果 (Qualys PC Results) の REST メッセージのパラメーター
    ソースフィールド 説明
    action リスト 要求された操作のタイプを示します。

    必要なパラメーター。変更は推奨されません。

    show_extended_evidence ブーリアン
    • 出力に詳細証拠情報を表示するには、1 に設定します。
    • 0 に設定するかまたは未指定の場合、出力に詳細証拠情報が表示されません。
    注:
    • hide_evidence=1 が指定されている要求では、show_extended_evidence=1 を指定することはできません。このようにするとエラーが発生します。詳細証拠は証拠データの一部であり、証拠データが表示されている場合にのみ表示されます。
    • このパラメーターは、ベースシステムには付属していません。
    cause_of_failure ブーリアン

    「1」を渡すと、Qualys は失敗の原因を返します。

    「0」を渡すと、Qualys はこれらの属性を返しません。

    注:
    このパラメーターは、ベースシステムには付属していません。
    policy_id 指定されたポリシーのコンプライアンス体制情報レコードを表示します。有効なポリシー ID が必要です。
    details すべて

    取得された体制の詳細レベルを示します。

    要件に応じて変更しても安全です。

    show_remediation_info (オプション) 1 に設定すると、XML または CSV 出力に修復情報が表示されます。デフォルトでは、修復情報は出力に含まれません。指定しない場合、修復情報は出力に含まれません。

    Qualys PCRS ポリシーホスト統合 (Qualys PCRS Policy Host Integration) の REST メッセージ

    Qualys PCRS ポリシーホスト統合 (Qualys PCRS Policy Host Integration) は、Qualys からホストデータを取得し、インスタンスでそのデータを処理します。

    表 : 5. Qualys PCRS ポリシーホスト統合 (Qualys PCRS Policy Host Integration) の REST メッセージのパラメーター
    パラメーター名 説明
    policyId ${lastRunDatetime}

    コンプライアンス評価のポリシー ID。

    Qualys PCRS テスト結果統合 (Qualys PCRS Test Results Integration)

    次の表に、送信される要求パラメーターを示します。

    表 : 6. Qualys PCRS テスト結果統合 (Qualys PCRS Test Results Integration) の REST メッセージのパラメーター
    パラメーター名 説明
    evidenceRequired ${lastRunDatetime}
    • デフォルト値は 0 です。これは、ホスト体制の証拠データが取得されないことを示します。
    • 証拠データを取得するには、値を 1 に設定します。
      注:
      値を 1 に変更すると、体制データの取得に必要な時間が長くなります。
    compressionRequired
    • デフォルト値は 1 で、出力が圧縮されることを示します。
    • データを圧縮しない場合は、値を 0 に設定します。
      注:
      データを圧縮しないと、体制データの取得に必要な時間が長くなります。