PaCE API-Aufrufparameter

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

    • Diese Tabelle beschreibt die Eigenschaften, die konfiguriert werden können, wenn PaCEAPI wird aufgerufen. 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 sein Standard Oder Testen .
    DocumentIds ja (Array von Tabelle, sysID) Die documentIds sind ein Array der Tabelle und der sysID (des bereitstellbaren Elements).
    Hinweis:
    Die in der vorherigen Tabelle angezeigten Eigenschaften können nicht im Test-Playground konfiguriert werden. Sie können nur verwendet werden, wenn PaCEAPI wird aufgerufen.
    Daten Ja Die richtlinienspezifischen Daten, die alle möglichen Anrufereingaben enthalten.
    ExecutionTag nein Kann verwendet werden, um einen oder mehrere Richtlinienausführungsdatensätze zu markieren, die aus diesem Aufruf resultieren. Es kann verwendet werden, um Ausführungsdetails der Richtlinie basierend auf dem ExecutionTag abzurufen.
    VerboseResponse nein falsch Der Standardwert ist Falsch . Wenn auf festgelegt Wahr , Zusätzliche Debug-Informationen (in diesem Fall die IDs der zugeordneten Richtlinien) werden zurückgegeben.
    Hier wird eine Beispielantwort mit options.verboseResponse:wahr angezeigt:
    // 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": []
}
    Wenn Options.verboseResponse:falsch , Die zugeordneten Richtlinien sind nicht in der Antwort enthalten.
    Fehlerschnell nein falsch Der Standardwert ist Falsch . Wenn diese Eigenschaft auf festgelegt ist Wahr , Die erste fehlgeschlagene Richtlinie stoppt die Ausführung aller zugeordneten Richtlinien.
    logLevel nein Info Dieser Parameter kann verwendet werden, um anzugeben, wie die Protokollnachrichten angezeigt werden sollen.
    • Info
    • debug
    • warnen
    • Fehler
    Zeitüberschreitung nein 3600 Der Zeitüberschreitungszeitraum in Sekunden. Der Standardwert ist 3600.
    WartForResult nein 3600 Die Wartezeitdauer in Sekunden.
    Hinweis:
    Dieser Parameter ist nur im Test-Playground verfügbar.