PaCE Paramètres d’invocation d’API

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 1 minute de lecture

    • Cette table décrit les propriétés qui peuvent être configurées lorsque l’API PaCE est invoquée. Ces propriétés peuvent être définies chaque fois que l’API est invoquée ou lorsque vous testez une stratégie dans le terrain de jeu de test.

    Nom de la propriété Obligatoire Valeur par défaut Description
    service yes Service d’appel qui invoque l’API.
    catégorie no Le type de catégorie.
    type no standard Peut être standard ou test.
    ID documents oui (tableau de table, sysID) Le documentIds est un tableau de la table et du sysID (de l’élément déployable).
    Remarque :
    Les propriétés affichées dans la table précédente ne peuvent pas être configurées dans le terrain de jeu de test. Ils ne peuvent être utilisés que lorsque l’API PaCE est invoquée.
    données yes Données spécifiques à la politique qui comprennent toutes les entrées possibles de l’appelant.
    Balise d’exécution no Permet de baliser un ou plusieurs enregistrements d’exécutions de politique résultant de cet invocation. Il peut être utilisé pour récupérer les détails d’exécution de la politique en fonction du executionTag.
    Réponse verbeuse no faux La valeur par défaut est faux. Si la valeur est définie sur vrai, des informations de débogage supplémentaires (dans ce cas, les ID des stratégies mappées) sont renvoyées.
    Un exemple de réponse d’invocation avec options.verboseResponse :true est affiché ici :
    // 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": []
}
    Si options.verboseResponse :false, les stratégies mappées ne sont pas incluses dans la réponse.
    FailFast no faux La valeur par défaut est faux. Si cette propriété est définie sur true, la première politique ayant échoué arrête l’exécution de toutes les politiques mappées.
    Niveau de connexion no infos Ce paramètre peut être utilisé pour spécifier comment les messages du journal doivent être affichés.
    • infos
    • déboguer
    • avertir
    • erreur
    timeout no 3600 Délai d’expiration, en secondes. La valeur par défaut est 3 600.
    waitForResult (en anglais seulement) no 3600 La période waitForResult en secondes.
    Remarque :
    Ce paramètre n’est disponible que dans le terrain de jeu de test.