Провера статуса анализе
URL се враћа као део заглавља Location
у одговору на захтев API-ја analyze
. Користи се за постављање упита путем HTTP GET
за статус посла за анализу. Када се посао анализе заврши, тело за одговор ће укључити URL или листу URL-ова у које се може преузети излаз резултата. Наставите да позивате овај URI док се не врати HTTP статусни кôд 200. Док посао још траје, враћаће се HTTP статусни кôд 202 са заглављем Location
које садржи исти URI који је враћен из analyze
. Када се врати одговор 200, својство resultFileUris
ће укључивати појединачну локацију или списак локација за преузимање излаза, што је могуће преузети у ZIP датотеци. Датотека у формату размене резултата статичке анализе (SARIF) V2 укључена је у ово преузимање ZIP датотеке која је JSON
форматирана датотека која садржи резултате анализе. Тело за одговор ће садржати објекат IssueSummary
који садржи резиме броја пронађених проблема.
Белешка
Препоручује се да сачекате између 15 и 60 секунди између провера статуса. Анализа обично траје од 1 до 5 минута.
Овај АПИ захтева OAuth токен који мора бити токен за исту клијентску апликацију која је покренула посао анализе.
Заглавља
Именуј | Тип | Очекивана вредност | Да ли је потребно? |
---|---|---|---|
Ауторизација | string | 1 OAuth носилац токен са захтевом Microsoft Entra за ИД апликације. | Да |
x-ms-tenant-id | GUID | ID закупца за апликацију. | Да |
x-ms-correlation-id | GUID | Идентификатор за покренуту анализу. Требало би да наведете исти ID за целокупно извршење (отпремање, анализа, статус) | Да |
Очекивани одговори
Шифра HTTP статуса | Сценарио | Резултат |
---|---|---|
200 | Пронађен је један резултат или више њих | Погледајте пример у наставку. Један резултат ће бити враћен. |
202 | Још увек се обрађује | Погледајте пример у наставку. Један резултат ће бити враћен. |
403 | Забрањено | Подносилац захтева није исти као творац захтева за анализу. |
404 | Није пронађено | Није могуће пронаћи захтев за анализу са референцом наведеном у URL-у. |
Очекивана заглавља одговора
Назив | Тип | Очекивана вредност | Да ли је потребно? |
---|---|---|---|
Локација | uri | URI који се користи у упиту за тренутни статус и за добијање резултата | Да |
Очекивано тело одговора
Следећа табела приказује структуру одговора за сваки захтев (само одговор HTTP 200 или 202).
Својство | Тип | Очекивана вредност | Да ли је потребно? |
---|---|---|---|
privacyPolicy | string | URI политике приватности. | Да |
Ток | int | Вредност која се креће од 0-100 процената до завршетка, где 10 значи да је обрада приближно 10% завршена. | Да |
runCorrelationId | GUID | Идентификатор захтева који је укључен у сваки захтев. Ово се може користити за корелацију са захтевом, ако је потребно. | Да |
статус | string | InProgress се враћа када се посао још увек обрађује. Failed се враћа када је дошло до катастрофалног проблема са обрадом посла на серверу. Више детаља би требало да буде у својству грешке. Finished се враћа када је посао успешно завршен без проблема. FinishedWithErrors се враћа када је посао успешно завршен, међутим, једно или више правила није успело да се заврши без грешке. Ово је само сигнал да знате да извештај можда није комплетан. Microsoft је свестан ових проблема у позадини и радиће на томе да се ствари дијагностикују и реше. |
Да |
resultFileUris | низ стрингова | Листа URI-ја који омогућавају директно преузимање резултата. Требало би да постоји један по датотеци која је била укључена у оригинални API позив анализе. | Не. Ово се укључује само када је обрада завршена. |
issueSummary | IssueSummary | Својства су наведена у наставку | Не. Ово се укључује само када је обрада завршена. |
issueSummary.criticalIssueCount | int | Број идентификованих проблема који имају критичну озбиљност у резултату | Да |
issueSummary.highIssueCount | int | Број идентификованих проблема који имају високу озбиљност у резултату | Да |
issueSummary.mediumIssueCount | int | Број идентификованих проблема који имају средњу озбиљност у резултату | Да |
issueSummary.lowIssueCount | int | Број идентификованих проблема који имају ниску озбиљност у резултату | Да |
issueSummary.informationalIssueCount | int | Број идентификованих проблема који имају информативну озбиљност у резултату | Да |
Пример: провера статуса по завршетку
Овај пример издаје позив за проверу статуса, а резултат је завршетак.
Захтев
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
одговор
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
}
}
Такође погледајте
Користите проверу Power Apps веб АПИ
Преузмите листу скупова правила
Преузмите листу правила
Отпремите датотеку
Позивање на анализу