Käivitused ja välised tõendid
Jälgi asünkroonseid käivitusi, tõlgenda tulemusi ja too ohutuid lühikese kehtivusega tõendeid.
run.trigger lisab töö järjekorda ja tagastab kohe. Jälgi iga tagastatud runId-d toiminguga run.get; tulemuse taga olevate faktide jaoks too run.evidence.
Käivituse jälgimine kursoriga
Esimene run.get kutse vajab ainult käivituse ID-d:
1{2 "runId": "jh7examplerunid"3}Salvesta vastuse arvuline cursor. Muudatuse ootamiseks saada sama käivituse ID, kursor ja waitMs:
1{2 "runId": "jh7examplerunid",3 "cursor": 42,4 "waitMs": 250005}HTTP-adapter küsitleb kord sekundis ja tagastab, kui kursor suureneb, käivitus jõuab lõppolekusse või ooteaeg saab täis. waitMs on piiratud vahemikku 0–25000 millisekundit; suurem väärtus piiratakse väärtuseni 25000. Vastus väärtusega timedOut: true on edukas tulemus, mis tähendab, et ooteakna jooksul midagi ei muutunud. Korda sama kursoriga või lõpeta ootamine; ära käsitle seda API veana.
Vastus sisaldab ka edenemist, sammude olekuid, tõendite saadavust ja välja next. next on soovitus, mitte määrav juhis: otsusta väljade status, verdict, validity, edenemise ja sammude põhjal.
Olek, otsus ja kehtivus
Need on eraldi väljad. status on täitmise olek, verdict on kliendile nähtav tulemus, kui see on olemas, ja validity näitab, kas käivitust sai hinnata.
status | verdict | validity | Tähendus |
|---|---|---|---|
queued | Puudub | not_evaluated | Ootab käivitamist. |
running | Puudub | not_evaluated | Täitmine on pooleli. |
retrying | Puudub | not_evaluated | Täitmist proovitakse uuesti ja lõpptulemust veel pole. |
passing | passed | valid | Käivitus lõppes eduka otsusega. |
failed | failed | valid | Käivitus lõppes ja tõendas ebaõnnestumist. |
unverified | unverified | valid | Käivitus lõppes, kuid ei tõendanud edu ega ebaõnnestumist. |
canceled | unverified | valid | Käivitus tühistati ja kinnitatud tulemust pole. |
invalid | unverified | invalid | Käivitus ei saanud anda kehtivat hinnangut. |
passing, failed, unverified, canceled ja invalid on pika oote lõppolekud. Vastuse next on wait olekute queued, running ja retrying korral, retry oleku invalid korral, evidence olekute failed, unverified või ebastabiilse eduka käivituse korral ning muidu none.
Välised tõendid
Kutsu POST /api/v1/run.evidence argumendiga runId ja soovi korral arvulise filtriga step. Vastus sisaldab käivituse olekut, otsust ja kehtivust ning kliendile ohutuid tõendeid iga kaasatud sammu kohta:
- sammu indeks, koostatud toiming ja valikuline sihtmärk;
- sammu olek
passed,failedvõiskippedja põhjus; - vaadeldud faktid, koostatud ootus, otsuse allikas ning kas järeltingimus tõendati;
- taastamiste arv ja diagnoos koos kategooria ning soovitatud toiminguga;
- neutraliseeritud toimingunimed ja sihtmärgid;
- aegumisajaga kuvatõmmise-, kaadri- või videolingid;
- sammu kestus.
Välised tõendid ei sisalda kunagi mudeli ega teenusepakkuja identiteeti, viipasid, tokeni- või kuluandmeid, käitaja toorvigu, sisemisi tööriistanimesid, käitaja siseandmeid ega töötlemata kasutajaliidese puid.
Allkirjastatud meedialingid
Igal run.evidence tagastatud meediaüksusel on allkirjastatud url ja expiresAt. URL kutsub:
GET /api/v1/evidence/<id>?kind=<screenshot|frame|video>&exp=<epoch-ms>&sig=<signature>Link kehtib 15 minutit ega vaja Beareri mandaati, sest allkiri kannab lühiajalist volitust. Kehtiv päring suunab 302 vastusega ajutisele salvestus-URL-ile. Kehtetu või aegunud allkiri tagastab 403; puuduv meedia tagastab 404. Parameetrite muutmise asemel kutsu värskete linkide saamiseks run.evidence uuesti.
Keskkonnaväärtused ja saladused
Keskkonna sihtmärgid võivad hoida nimelisi käitusaegseid väärtusi. environment.list ja environment.get tagastavad ainult runtimeValueNames; nad ei tagasta kunagi väärtusi. Viita kasutajaliidese täitesammus väärtusele nime järgi:
1{2 "action": "fill",3 "target": "Password",4 "valueSpec": {5 "kind": "environment",6 "variable": "LOGIN_PASSWORD"7 }8}Viidatud saladuse puhul saadab Autonomy väärtuse käitajale vahetult enne täitmist autenditud TLS-i nõudekanali kaudu. Käitaja hoiab seda ainult mälus. Mudel näeb kohatäitjat {{env.LOGIN_PASSWORD}} ning rakendusraamistik asendab väärtuse alles täitmistoimingu väljasaatmisel. Väärtus lisatakse jälgede, diagnooside, logide, väliste tõendite ja playbook'i mälu redigeerimisloendisse; seda ei kirjutata kettale ega tagastata ühegi käitaja marsruudi kaudu.
Kui viidatud väärtus puudub, ebaõnnestub käivitus suletult enne sammude algust diagnoosiga environment. Uue põlvkonna käitaja toetab asendamist; stabiilne käitaja keeldub keskkonnaväärtustele viitavate sammudega käivitust nõudmast ega käivita seda ilma saladuseta.
API sihtmärkide käitusaegsed väärtused on eraldi: run.trigger saab need edastada väljal targets.api.runtimeValues, samal ajal kui API mandaadisidumised lahendavad {{env.NAME}} jätkuvalt käitaja hostikeskkonnast.