Извикване на анализ

Статия
03/27/2023

Инициирането на задача за анализ се извършва чрез подаване на POST заявка до маршрута analyze. Анализът може да бъде дълъг процес, който обикновено продължава по-дълго от минута. API първо прави някаква основна валидация, инициира заявката в бекенда, като изпраща задача и след това отговаря с код на състоянието 202 и заглавка Location или със съответните данни за грешка. Стойността на заглавка Location е URL адрес, който може да се използва за проверка на състоянието на заявката и за получаване на URL адресите на резултатите. Има различни опции чрез POST действие за персонализиране на задачата въз основа на вашите критерии, като например списъка с правила или набори от правила, файлове за изключване от анализа и други. Можете да започнете анализа, като използвате следния [Geographical URL]/api/analyze?api-version=1.0.

Бележка

Препоръчва се да изчакате между 15 и 60 секунди между проверките на състоянието. Обикновено анализът отнема между 1 до 5 минути.
Този API изисква токен. OAuth

Заглавки

Име	Тип	Очаквана стойност	Задължително?
Удостоверяване	string	Твърдение за OAuth 1 токен на приносител с Microsoft Entra ИД на приложението.	да
x-ms-tenant-id	GUID	Идентификационен номер на клиента за приложението.	да
x-ms-correlation-id	GUID	Идентификаторът за извършване на анализа. Трябва да предоставите един и същ ИД за цялото изпълнение (качване, анализ, състояние).	да
Приемам	обект	`application/json, application/x-ms-sarif-v2`	да
Accept-Language	string	Езиковият код или кодове (напр. en-US). Стойността по подразбиране е en-US. Ако са предоставени няколко езика, първият ще бъде първичен. Въпреки това, всички преводи (ако езикът се поддържа) ще бъдат включени.	не

Съдържание

Често използвани опции:

Свойство	Тип	Очаквана стойност	Задължително?
sasUriList	масив от низове	Списък на URI, който предоставя услугата достъп за изтегляне на едно решение, zip файл, съдържащ множество файлове с решение, или пакет.	Да
ruleSets	масив на персонализиран	0 или повече	Не
ruleSets.id	guid	Идентификаторът на набора от правила, който може да бъде намерен чрез запитване в API за набор от правила.	Не, но това обикновено е това, което бихте искали да използвате. Трябва да използвате или това, или кодове с правила.
ruleCodes.code	string	ИД на желаното правило, който може да бъде намерен чрез запитване на набора от правила и API за набор от правила.	Не, трябва да използвате или това, или ruleSets.
fileExclusions	масив от низове	Списък с имена на файлове или модели на имена на файлове, които да се изключат. Съществува поддръжка за използване на „“ като заместващ знак в началото и/или в края на името на файла (напр. jquery.dll и jquery).	No

Очаквани отговори

Код на състояние на HTTP	Сценарий	Result
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

Вижте също

Използвайте уеб API за Power Apps проверка
Извличане на списъка с набори от правила
Извличане на списъка с правила
Качване на файл
Проверка за състояние на анализа

Споделяне чрез