Позивање анализе

Чланак
10/16/2024

Покретање посла анализе обавља се подношењем POSTзахтева за руту analyze. Анализа може бити дуг процес који обично траје дуже од једног минута. API прво изврши неку основну проверу ваљаности, покрене захтев у позадини подношењем посла, а затим одговори статусним кодом 202 и заглављем Location или са одговарајућим детаљима о грешци. Вредност заглавља Location је URL адреса која се може користити за проверу статуса захтева и добијање URL-ова резултата. Постоје разне опције кроз POST радњу за прилагођавање посла на основу ваших критеријума, као што је листа правила или скупови правила, датотеке за изузимање из анализе и још много тога. Анализу можете покренути помоћу следећег [Geographical URL]/api/analyze?api-version=1.0.

Белешка

Препоручује се да сачекате између 15 и 60 секунди између провера статуса. Анализа обично траје од 1 до 5 минута.
Овај АПИ захтева OAuth токен.

Заглавља

Именуј	Тип	Очекивана вредност	Да ли је потребно?
Ауторизација	string	OAuth 1 носилац токен са Microsoft Entra ИД ИД захтевом.	Да
x-ms-tenant-id	GUID	ID закупца за апликацију.	Да
x-ms-correlation-id	GUID	Идентификатор за покренуту анализу. Требало би да наведете исти ID за целокупно извршење (отпремање, анализа, статус).	Да
Прихватам	објекат	`application/json, application/x-ms-sarif-v2`	Да
Accept-Language	string	Шифра или шифре језика (нпр. en-US). Подразумевани језик је en-US. Ако се наведе више језика, први ће бити примарни. Међутим, биће укључени сви преводи (уколико је језик подржан).	не

Тело

Најчешће коришћене опције:

Својство	Тип	Очекивана вредност	Да ли је потребно?
sasUriList	низ стрингова	Листа УРИ-ја која пружа приступ услузи за преузимање једног решења, ZIP датотека која садржи више датотека са решењима или пакет.	Да
ruleSets	низ прилагођених	0 или више	Не
ruleSets.id	guid	ID скупа правила, који се може пронаћи упитом API-ја за скуп правила.	Не, али то је обично оно што бисте желели да користите. Морате користити или ово или ruleCodes.
ruleCodes.code	string	ID жељеног правила, који се може пронаћи упитом API-ја за скуп правила и правило.	Не, морате користити или ово или ruleSets.
fileExclusions	низ стрингова	Листа имена датотека или образаца имена датотека које треба искључити. Постоји подршка за коришћење знака "" као џокера на почетку и/или крају назива датотеке (нпр. jquery.dll и jquery).	No

Очекивани одговори

Шифра HTTP статуса	Сценарио	Резултат
202	Захтев за анализу је прихваћен и URI за проверу статуса је враћен у заглављу `Location`	Нема тела резултата
400	Послата је датотека која није ZIP, наведени су погрешни параметри или датотека садржи вирус	Нема тела резултата
409	Послат је захтев са дупликатом вредности заглавља `x-ms-correlation-id`	Нема тела резултата

Очекивана заглавља одговора

Назив	Тип	Очекивана вредност	Да ли је потребно?
Локација	Uri	URL који се користи у упиту за тренутни статус и за добијање резултата	Да

Пример: иницирајте анализу

Ово је пример покретања посла анализе са скупом правила AppSource сертификација, једном датотеком и искључујући датотеке које садрже текст jquery и json у називу.

Захтев

POST [Geographical URI]/api/analyze?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

{
    "ruleSets": [{
        "id": "0ad12346-e108-40b8-a956-9a8f95ea18c9"
    }],
    "sasUriList": ["https://testenvfakelocation.blob.core.windows.net/mySolution.zip"],
    "fileExclusions": ["*jquery*", "*json*"]
}

одговор

HTTP/1.1 202 Accepted
Content-Type: application/json; charset=utf-8
Location: [Geographical URI]/api/status/9E378E56-6F35-41E9-BF8B-C0CC88E2B832&api-version=1.0

Такође погледајте

Користите проверу Power Apps веб АПИ
Преузмите листу скупова правила
Преузмите листу правила
Отпремите датотеку
Провера статуса анализе

Делите путем