Egiaztatu analisiaren egoera zein den
URLa itzultzen da Location
goiburua goiburuari egindako eskaerari erantzunez analyze
API. HTTP bidez kontsultatzeko erabili behar da GET
analisiaren lanpostuaren egoeragatik. Azterketa lana bukatutakoan, erantzun organoak emaitza URLak deskargatu ahal izango dituen URL edo URL zerrenda sartuko ditu. Jarraitu URI honetara deitzen 200 HTTP egoera kodea itzuli arte. Lana martxan dagoen bitartean, 202 HTTP egoera kodea itzuliko da Location
itzuli den URI bera duen goiburua analyze
. 200 erantzuna itzuli ondoren, resultFileUris
propietateak irteera kokapen deskargatuen zerrenda bakarra edo zerrenda barne izango du, zip fitxategi batean dagoena. A Analisi estatikoaren emaitzak elkartrukatzeko formatua (SARIF) V2 formateatutako fitxategia hau da JSON
formateatutako fitxategia, analisiaren emaitzak biltzen dituena. Erantzunen organoak an IssueSummary
aurkitutako gaien zenbaketaren laburpen bat duen objektua.
Oharra
Egoera kontrolen artean 15 eta 60 segundo artean itxaron behar da. Analisiak 1 eta 5 minutu artean izaten ditu normalean.
API honek OAuth token bat behar du, analisi-lana hasi zuen bezero-aplikazio beraren tokena izan behar duena.
Goiburuak
Eman izena | Idatzi | Esperotako balioa | Beharrezkoa? |
---|---|---|---|
Baimena | katea | OAuth 1 eramaile-tokena Microsoft Entra Aplikazioaren IDaren erreklamazioa duena. | bai |
x-ms-tenant-id | GUIDa | Eskabidearen maizteraren NANa. | bai |
x-ms-correlation-id | GUIDa | Azterketarako identifikatzailea. ID bera eman beharko zenuke exekuzio osorako (kargatu, aztertu, egoera) | bai |
Espero diren erantzunak
HTTP egoera-kodea | Egoera | Emaitza |
---|---|---|
200 | Emaitza bat edo gehiago aurkitu dira | Ikusi beheko adibidea. Emaitza bat itzuliko da. |
202 | Oraindik prozesatzen | Ikusi beheko adibidea. Emaitza bat itzuliko da. |
403 | Debekatuta | Eskatzailea ez da azterketa eskaeraren jatorriaren bera. |
404 | Ez da aurkitu | Ezin izan da URL eskaeran erreferentziarekin aurkitu azterketa eskaera. |
Aurreikusitako erantzun goiburuak
Izena | Mota | Esperotako balioa | Beharrezkoa? |
---|---|---|---|
Kokapena | uri | URI erabiltzeko eskatzeko uneko egoerarako eta emaitzak lortzeko | bai |
Espero diren erantzunen gorputza
Hurrengo taulan, eskaera bakoitzaren erantzunaren egitura azaltzen da (HTTP 200 edo 202 erantzuna soilik).
Propietatea | Mota | Esperotako balioa | Beharrezkoa? |
---|---|---|---|
privacyPolicy | katea | Pribatutasun politikaren URI. | Yes |
Egoera | osoko zenbakia | 0-100 portzentajea osatutakoa da, eta 10ek prozesua % 10 ingurukoa dela esan nahi du. | Yes |
runCorrelationId | GUIDa | Eskaera bakoitzean biltzen den eskaeraren identifikatzailea. Eskaerarekin erlazionatzeko erabil daiteke, behar izanez gero. | Yes |
egoera | katea | InProgress lana oraindik prozesatzen ari denean itzultzen da. Failed zerbitzarian lana prozesatzen arazo hondamendi bat egon zenean itzultzen da. Xehetasun gehiago egon beharko lirateke akatsen propietatean. Finished lana arazorik gabe ondo amaitu denean itzultzen da. FinishedWithErrors lana behar bezala amaitu denean itzultzen da; hala ere, arau bat edo gehiago huts egin dira akatsik gabe. Txostena osorik ez dagoela jakiteko seinale hutsa da. Microsoft backend-en arazo horien berri da eta gauzak diagnostikatu eta konpontzeko lan egingo du. |
Yes |
resultFileUris | Kate sorta | Irteera zuzenean deskargatzeko aukera ematen duten URIen zerrenda. Fitxategi bakoitzeko bat egon beharko litzateke aztertzeko jatorrizko APIaren deian. | Ez. Prozesazioa amaitu denean bakarrik sartzen da. |
issueSummary | IssueSummary | Jarraian agertzen diren propietateak | Ez. Prozesazioa amaitu denean bakarrik sartzen da. |
issueSummary.criticalIssueCount | osoko zenbakia | Emaitzan larritasun kritikoa duten identifikatutako arazoen kopurua | Yes |
issueSummary.highIssueCount | osoko zenbakia | Emaitzan larritasun altua duten identifikatutako arazoen kopurua | Yes |
issueSummary.mediumIssueCount | osoko zenbakia | Emaitzan larritasun ertaina duten identifikatutako arazoen kopurua | Yes |
issueSummary.lowIssueCount | osoko zenbakia | Emaitzan larritasun baxua duten identifikatutako arazoen kopurua | Yes |
issueSummary.informationalIssueCount | osoko zenbakia | Emaitzan larritasun informazioa duten identifikatutako arazoen kopurua | Yes |
Adibidea: amaitutakoan egoeraren egiaztapena
Adibide honek egoera egiaztatzeko deia igortzen du.
Eskaera
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
erantzun
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
}
}
Ikus baita ere
Erabili Power Apps checker web APIa
Arau multzoen zerrenda berreskuratu
Arauen zerrenda berreskuratu
Kargatu fitxategi bat
Deitu azterketa