PaCE API 呼び出しパラメーター

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

    • この表では、PaCE API を呼び出すときに設定できるプロパティについて説明します。これらのプロパティは、API を呼び出すとき、またはテストプレイグラウンドでポリシーをテストするときに設定できます。

    プロパティ名 必須 デフォルト値 説明
    service はい API を呼び出す呼び出しサービス。
    category いいえ カテゴリのタイプ。
    type いいえ standard standard または test にすることができます。
    documentIds はい (テーブルと sysID のアレイ ) documentIds は、(展開可能項目の) テーブルと sysID のアレイです。
    注:
    上の表に示したプロパティは、テストプレイグラウンドでは構成できません。これらは、PaCE API を呼び出す場合にのみ使用できます。
    data はい 考えられるすべての発信者入力を含むポリシー固有のデータ。
    executionTag いいえ この呼び出しの結果としての 1 つ以上のポリシー実行レコードに、タグを付けるために使用できます。executionTag に基づくポリシーの実行の詳細を取得するために使用できます。
    verboseResponse いいえ false デフォルト値は false です。true に設定すると、追加のデバッグ情報 (この場合はマッピングされたポリシーの ID) が返されます。
    options.verboseResponse:true を使用した呼び出し応答の例を次に示します。
    // Sample execution response
{
  "rootExecutionId": "50202b3ec37b101017e06c576e40dd81",
  "mappedPolicies": [
    {
      "policyId": "3d1de0a8c363101017e06c576e40dde4",
      "policyName": "Production Database Policy",
      "shortDescription": "Policy to check database passwords",
      "versonId": "4ed08520c3a3101017e06c576e40ddcb",
      "versonTyep": "4f2cb75473331010ce6c39282bf6a753",
      "versionState": "published",
      "versionApproval": "approved"
    },
    {
      "policyId": "addd2ca8c363101017e06c576e40dd12",
      "policyName": "API Policy",
      "shortDescription": "Policy to check API policies",
      "versonId": "a6418920c3a3101017e06c576e40dd57",
      "versonTyep": "4f2cb75473331010ce6c39282bf6a753",
      "versionState": "published",
      "versionApproval": "approved"
    }
  ],
  "logs": []
}
    options.verboseResponse:false の場合、マップされたポリシーは応答に含まれません。
    failFast いいえ false デフォルト値は false です。このプロパティが true に設定されている場合、最初に失敗したポリシーによって、マップされたすべてのポリシーの実行が停止されます。
    logLevel いいえ info このパラメーターにより、ログメッセージをどのように表示するかを指定できます。
    • info
    • debug
    • warn
    • error
    timeout いいえ 3600 タイムアウト期間 (秒単位)。デフォルト値は 3600 です。
    waitForResult いいえ 3600 waitForResult 期間 (秒単位)。
    注:
    このパラメーターは、テストプレイグラウンドでのみ使用できます。