PaCE API-Aufrufparameter

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 1 Minute Lesedauer

    • In dieser Tabelle werden die Eigenschaften beschrieben, die konfiguriert werden können, wenn die API PaCE aufgerufen wird. Diese Eigenschaften können festgelegt werden, wenn die API aufgerufen wird oder wenn Sie eine Richtlinie im Test-Playground testen.

    Eigenschaftsname Erforderlich Standardwert Beschreibung
    service Ja Der aufrufende Service, der die API aufruft.
    Kategorie nein Der Kategorietyp.
    Typ nein Standard Kann Standard oder Testsein.
    documentIds ja (Array von Tabelle, sysID) „documentIds“ ist ein Array der Tabelle und der Sys-ID (des bereitstellbaren Elements).
    Hinweis:
    Die in der vorherigen Tabelle aufgeführten Eigenschaften können im Test-Playground nicht konfiguriert werden. Sie können nur verwendet werden, wenn die API PaCE aufgerufen wird.
    Daten Ja Die richtlinienspezifischen Daten, die alle möglichen Anrufereingaben enthalten.
    executeTag nein Kann verwendet werden, um einen oder mehrere Richtlinienausführungsdatensätze zu kennzeichnen, die aus diesem Aufruf resultieren. Sie kann verwendet werden, um Ausführungsdetails der Richtlinie basierend auf dem „executionTag“ abzurufen.
    verboseResponse nein falsch Der Standardwert ist „false“. Bei Festlegung auf truewerden zusätzliche Debug-Informationen (in diesem Fall die IDs der zugeordneten Richtlinien) zurückgegeben.
    Hier sehen Sie ein Beispiel für eine Aufrufantwort mitoptionen.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": []
}
    Bei Festlegung auf Options.verboseResponse:falsesind die zugeordneten Richtlinien nicht in der Antwort enthalten.
    „failFast“ nein falsch Der Standardwert ist „false“. Wenn diese Eigenschaft auf truefestgelegt ist, stoppt die erste fehlgeschlagene Richtlinie die Ausführung aller zugeordneten Richtlinien.
    logLevel nein Info Mit diesem Parameter kann festgelegt werden, wie die Protokollnachrichten angezeigt werden sollen.
    • Info
    • debuggen
    • warnen
    • Fehler
    Zeitüberschreitung nein 3600 Die Zeitüberschreitung in Sekunden. Der Standardwert ist 3600.
    wartenFürErgebnis nein 3600 Der Zeitraum von „waiteForResult“ in Sekunden.
    Hinweis:
    Dieser Parameter ist nur im Test-Playground verfügbar.