Analyysin tilan tarkistaminen
URL-osoite palautetaan osana Location
-otsikkoa vastauksena ohjelmointirajapinnan analyze
-pyyntöön. Sitä käytetään kyselemään analyysitehtävän tilaa HTTP GET
:in kautta. Kun analyysitehtävä on suoritettu, vastausteksti sisältää URL-osoitteen tai URL-osoitteiden luettelon, josta tulosten tuloste voidaan ladata. Jatka tämän URI-tunnuksen kutsumista, kunnes palautetaan HTTP-tilakoodi 200. Kun työ on yhä käynnissä, järjestelmä palauttaa HTTP-tilakoodin 202, joka palautetaan siten, että Location
-otsikko sisältää saman URI-tunnuksen, joka palautettiin kohteesta analyze
. Kun 200-vastaus on palautettu, resultFileUris
-ominaisuus sisältää tulosteen yksittäisen lataussijainnin tai luettelon sellaisista zip-tiedostossa. Alustettu Static Analysis Results Interchange Format (SARIF) V2 -tiedosto sisältyy tähän zip-lataukseen, joka on JSON
-muotoinen tiedosto, joka sisältää analyysin tulokset. Vastausteksti sisältää IssueSummary
-objektin, jonka sisältää yhteenvedon löydettyjen ongelmien määrästä.
Muistiinpano
Tilan tarkastuksien välillä on suositeltavaa odottaa 15–60 sekuntia. Analyysin suorittaminen kestää yleensä 1–5 minuuttia.
Tämä ohjelmointirajapinta edellyttää OAuth-tunnusta, jonka on oltava saman asiakassovelluksen tunnus, joka käynnisti analyysitehtävän.
Ylätunnisteet
Nimi | Laji | Odotettu arvo | Onko pakollinen? |
---|---|---|---|
Valtuutus | string | OAuth 1 -haltijatunnus, jossa on Microsoft Entra -sovellustunnusvaatimus. | yes |
x-ms-tenant-id | GUID | Sovelluksen vuokraajan tunnus. | kyllä |
x-ms-correlation-id | GUID | Analyysisuorituksen tunnus. Anna koko suorituksen suoritukselle (lataus, analysointi, tila) sama tunnus. | kyllä |
Odotetut vastaukset
HTTP-tilakoodi | Skenaario | Tulos |
---|---|---|
200 | Vähintään yksi tulos löytyi | Katso esimerkki alla. Yksi tulos palautetaan. |
202 | Käsittely kesken | Katso esimerkki alla. Yksi tulos palautetaan. |
403 | Kielletty | Analysointipyynnön pyytäjä ei ole sama kuin alullepanija. |
404 | Ei löytynyt | URL-osoitteessa annettua viitettä sisältävää analysointipyyntöä ei löydy. |
Odotetut vastausotsikot
Nimi | Laji | Odotettu arvo | Onko pakollinen? |
---|---|---|---|
Location | uri | URI, jota käytetään kyseltäessä nykyistä tilaa ja tulosten saamiseen | kyllä |
Odotettu vastausteksti
Seuraavassa taulukossa esitetään kunkin pyynnön vastauksen rakenne (vain HTTP 200- tai 202 -vastaus).
Ominaisuus | Laji | Odotettu arvo | Onko pakollinen? |
---|---|---|---|
privacyPolicy | string | Tietosuojakäytännön URI. | Kyllä |
Edistyminen | kokonaisluku | Arvo, joka vaihtelee 0–100 prosentin valmiuden välillä. 10 tarkoittaa, että käsittely on noin 10-prosenttisesti valmis. | Kyllä |
runCorrelationId | GUID | Pyyntötunnus, joka sisältyy kuhunkin pyyntöön. Tämän avulla voidaan tarvittaessa korreloida pyynnön kanssa. | Kyllä |
tila | string | InProgress palautetaan, kun työtä käsitellään edelleen. Failed palautetaan, kun työn käsittelyssä palvelimessa ilmeni vakava ongelma. Virhe-ominaisuuden pitäisi sisältää lisätietoja. Finished palautetaan, kun työ on suoritettu onnistuneesti ongelmitta. FinishedWithErrors palautetaan, kun työn suorittaminen onnistui, mutta yhtä tai useampaa sääntöä ei voitu suorittaa loppuun virheittä. Tämä on puhtaasti signaali, josta tiedät, että raportti ei ehkä ole valmis. Microsoft on tietoinen näistä ongelmista tausta-alueella ja pyrkii saamaan asiat diagnosoitua ja käsiteltyä. |
Kyllä |
resultFileUris | merkkijonomatriisi | Luettelo URI-osoitteista, jotka mahdollistavat tulosteen suoran lataamisen. Näitä pitäisi olla yksi jokaista tiedostoa kohden, joka sisällytettiin alkuperäiseen analysoinnin ohjelmointirajapintakutsuun. | Ei. Tämä sisällytetään vain silloin, kun käsittely on valmis. |
issueSummary | IssueSummary | Alla luetellut ominaisuudet | Ei. Tämä sisällytetään vain silloin, kun käsittely on valmis. |
issueSummary.criticalIssueCount | kokonaisluku | Niiden tunnistettujen ongelmien määrä, joiden tuloksena on vakava taso | Kyllä |
issueSummary.highIssueCount | kokonaisluku | Niiden tunnistettujen ongelmien määrä, joiden tuloksena on erittäin vakava taso | Kyllä |
issueSummary.mediumIssueCount | kokonaisluku | Niiden tunnistettujen ongelmien määrä, joiden tuloksena on keskivakava taso | Kyllä |
issueSummary.lowIssueCount | kokonaisluku | Niiden tunnistettujen ongelmien määrä, joiden tuloksena on alhaisen vakavuuden taso | Kyllä |
issueSummary.informationalIssueCount | kokonaisluku | Niiden tunnistettujen ongelmien määrä, joiden tuloksena on tiedottava vakavuuden taso | Kyllä |
Esimerkki: tilantarkistus, kun valmis
Tässä esimerkissä annetaan tilantarkistuksen kutsu, jossa tuloksena on loppuun suorittaminen.
Pyyntö
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
}
}
Katso myös
Power Apps -tarkistustoiminnon verkko-ohjelmointirajapinnan käyttäminen
Sääntöjoukkoluettelon noutaminen
Sääntöluettelon noutaminen
Tiedoston lataaminen
Analyysin käynnistäminen