Analīzes statusa pārbaude

Raksts
03/27/2023

URL tiek atgriezts kā daļa no Location galvenes, atbildot uz analyze API pieprasījumu. Tas ir jāizmanto, lai vaicātu, izmantojot HTTP GET analīzes uzdevuma statusam. Kad analīzes uzdevums ir pabeigts, atbildes pamatteksts iekļaus URL vai URL sarakstu, kurā varēs lejupielādēt rezultātus. Turpiniet zvanīt šim URI, līdz tiek atgriezts HTTP statusa kods 200. Kamēr uzdevums joprojām darbojas, HTTP statusa kods 202 tiks atgriezts kopā ar virsrakstu, kurā ir Location šis pats URI, kas tika atgriezts no analyze. Pēc tam, kad ir atgriezta 200 atbilde, resultFileUris rekvizīts iekļaus vienu vai sarakstu ar lejupielādējamajām atrašanās vietām, kas ir iekļauta ZIP failā. Šajā ZIP lejupielādē ir iekļauts Statiskās analīzes rezultātu apmaiņas formāts (SARIF) V2 formatētais fails, kas ir JSON formatēts fails, kas satur analīzes rezultātus. Atbildes pamattekstā būs IssueSummary objekts, kas ietver atrasto problēmu skaita kopsavilkumu.

Note

Ir ieteicams starp statusa pārbaudēm nogaidīt no 15 līdz 60 sekundēm. Analīzes palaišana parasti aizņem no 1 līdz 5 minūtēm.
Šim API nav nepieciešams OAuth marķieris, kam ir jābūt marķierim tai pašai klienta lietojumprogrammai, kas uzsāka analīzes uzdevumu.

Virsraksti

Nosaukums/vārds, uzvārds	Veids	Paredzētā vērtība	Vai jānorāda obligāti?
Autorizācija	string	OAuth 1 uzrādītāja marķieris ar Microsoft Entra lietojumprogrammas ID prasību.	jā
x-ms-tenant-id	GUID	Lietojumprogrammas nomnieka ID.	jā
x-ms-correlation-id	GUID	Analīzes izpildes identifikators. Ir jānodrošina tas pats ID visai izpildei (augšupielādēt, analizēt, statuss)	jā

Paredzamās atbildes

HTTP statusa kods	Scenārijs	Rezultāts
200	Tika atrasts viens vai vairāki rezultāti	Skatiet tālāk sniegto piemēru. Tiks atgriezts viens rezultāts.
202	Joprojām apstrādā	Skatiet tālāk sniegto piemēru. Tiks atgriezts viens rezultāts.
403	Aizliegts	Prasītājs nav tās pats kas analīzes pieprasījuma veidotājs.
404	Nav atrasta	Nevar atrast analīzes pieprasījumu, izmantojot atsauci, kas norādīta URL.

Paredzētās atbildes galvenes

Nosaukums/vārds, uzvārds	Veids	Paredzētā vērtība	Vai jānorāda obligāti?
Atrašanās vieta	URI	URI var izmantot, lai vaicātu par pašreizējo statusu un iegūtu rezultātus	jā

Paredzamo atbilžu struktūra

Tālāk sniegtajā tabulā ir aprakstīta atbildes struktūra katram pieprasījumam (tikai HTTP 200 vai 202 atbildei).

Rekvizīts	Veids	Paredzētā vērtība	Vai jānorāda obligāti?
privacyPolicy	string	Privātuma politikas URI.	Jā
Norise	int	Vērtība diapazonā no 0-100 procentos, kur 10 nozīmē, ka apstrāde ir pabeigta aptuveni 10% apmērā.	Jā
runCorrelationId	GUID	Katrā pieprasījumā ir iekļauts pieprasījuma identifikators. To var izmantot, lai vajadzības gadījumā to saistītu ar pieprasījumu.	Jā
statuss	string	`InProgress` tiek atgriezts, ja uzdevums joprojām tiek apstrādāts. `Failed` tiek atgriezts, ja serverī radās katastrofāla problēma ar uzdevuma apstrādi. Kļūdas rekvizītā ir jābūt detalizētākai informācijai. `Finished` tiek atgriezts, kad uzdevums ir veiksmīgi pabeigts bez problēmām. `FinishedWithErrors` tiek atgriezts, ja uzdevums ir veiksmīgi pabeigts, tomēr viens vai vairāki noteikumi nav pabeigti bez kļūdas. Tas ir tikai signāls, lai jūs zinātu, ka atskaite nav pilnīga. Microsoft ir informēti par šīm aizmugurē esošajām problēmas un strādās, lai problēmas diagnosticētu un risinātu.	Jā
resultFileUris	virkņu masīvs	URI saraksts, kas ļauj tieši lejupielādēt izvades dokumentus. Katrā failā vajadzētu būt vienam, kas tika iekļauts sākotnējā analīzes API izsaukumā.	Nē. Tas ir iekļauts tikai tad, kad apstrāde ir pabeigta.
issueSummary	IssueSummary	Tālāk norādītie rekvizīti	Nē. Tas ir iekļauts tikai tad, kad apstrāde ir pabeigta.
issueSummary.criticalIssueCount	int	Identificēto problēmu skaits, kuru rezultāts ir kritiski nopietns	Jā
issueSummary.highIssueCount	int	Identificēto problēmu skaits, kuru rezultāts ir augstas nopietnības	Jā
issueSummary.mediumIssueCount	int	Identificēto problēmu skaits, kuru rezultāts ir vidējas nopietnības	Jā
issueSummary.lowIssueCount	int	Identificēto problēmu skaits, kuru rezultāts ir zemas nopietnības	Jā
issueSummary.informationalIssueCount	int	Identificēto problēmu skaits, kuru rezultāts ir informatīvi nopietns	Jā

Piemērs: statusa pārbaude, kad tas izdarīts

Šajā piemērā tiek risināts statusa pārbaudes izsaukums, kura rezultāts ir pabeigšanas statuss.

Pieprasījums

GET [Geographical URI]/api/status/9E378E56-6F35-41E9-BF8B-C0CC88E2B832&api-version=1.0
Accept: application/json
Content-Type: application/json; charset=utf-8
x-ms-correlation-id: 9E378E56-6F35-41E9-BF8B-C0CC88E2B832
x-ms-tenant-id: F2E60E49-CB87-4C24-8D4F-908813B22506

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "privacyPolicy":"https://go.microsoft.com/fwlink/?LinkID=310140",
    "progress":100,
    "resultFileUris":["https://fakeblob.blob.core.windows.net/report-files/mySolution.zip?sv=2017-11-09&sr=b&sig=xyz&se=2019-06-11T20%3A27%3A59Z&sp=rd"],"runCorrelationId":"9E378E56-6F35-41E9-BF8B-C0CC88E2B832","status":"Finished","issueSummary":
    {
        "informationalIssueCount":0,
        "lowIssueCount":0,
        "mediumIssueCount":302,
        "highIssueCount":30,
        "criticalIssueCount":0
    }
}

Skatiet arī

Izmantot Power Apps pārbaudītāja tīmekļa API
Kārtulu kopu saraksta izgūšana
Kārtulu saraksta izgūšana
Faila augšupielādēšana
Analīzes izsaukšana

Kopīgot, izmantojot