Талдау күйін тексеру

Мақала
03/27/2023

URL мекенжайы analyze API сұрауына жауап ретінде Location үстіңгі деректемесінің бөлігі ретінде қайтарылады. Бұл талдау тапсырмасының күйін HTTP GET арқылы сұрау үшін пайдаланылу қажет. Талдау жұмысы аяқталғаннан кейін жауап беру бөлімі URL мекен-жайын немесе нәтижелерді шығаруға болатын URL мекен-жайларының тізімін қамтиды. 200 HTTP күй коды қайтарылғанша осы URI шақыруды жалғастырыңыз. Жұмыс әлі де жалғасу барысында болғанда 202 HTTP күй коды analyze қайтарылған бір URI тұратын Location үстіңгі деректемесімен қайтарылады. 200 жауап қайтарылғаннан кейін resultFileUris сипаты zip файлында қамтылатын шығарылымның жүктелетін орындарының тізімін немесе жалғыз тізімін қамтиды. Статикалық талдау нәтижелерінің өзара алмасу пішімі (SARIF) V2 пішімделген файл талдау нәтижелерінен тұратын JSON пішімделген файл болып табылатын осы zip жүктеу ішіне кіреді. Жауап беру мәтіні табылған шығарылымдары санының жиынтығынан тұратын IssueSummary нысанынан тұрады.

Ескертпе

Күйді тексеру арасында 15-60 секунд аралығында күту ұсынылады. Талдауға әдетте 1-5 минут аралығындағы уақыт кетеді.
Бұл API талдау тапсырмасын бастаған сол клиенттік қолданба үшін таңбалауыш болуы тиіс OAuth таңбалауышты қажет етеді.

Үстіңгі деректемелер

Аты	Түр	Күтілген мән	Міндетті ме?
Авторизация	string	OAuth Қолданба идентификаторы шағымы бар Microsoft Entra 1 жеткізуші таңбалауышы.	иә
x-ms-tenant-id	GUID	Бағдарламаның қатысушысы идентификаторы.	иә
x-ms-correlation-id	GUID	Талдауды іске қосу идентификаторы. Бүкіл орындау үшін бірдей идентификатор енгізу қажет (жүктеу, талдау, күй)	иә

Күтілген жауаптар

HTTP күй коды	Сценарий	Нәтиже
200	Бір немесе бірнеше нәтижелер табылды	Төмендегі мысалды қараңыз. Бір нәтиже қайтарылады.
202	Өңделуде	Төмендегі мысалды қараңыз. Бір нәтиже қайтарылады.
403	Тыйым салынған	Сұраушы талдау сұрауының жасаушысымен бірдей емес.
404	Табылмады	URL мекенжайы бойынша берілген сілтемемен талдау сұранысын табу мүмкін емес.

Күтілетін жауап тақырыптары

Аты	Түрі	Күтілген мән	Міндетті ме?
Орналасқан жері	uri	Ағымдағы күйді сұрау және нәтижелерді алу үшін URI пайдалану	иә

Күтілген жауап мәтіні

Төмендегі кестеде әр сұранысқа жауап құрылымы көрсетілген (тек HTTP 200 немесе 202 жауап).

Сипат	Түрі	Күтілген мән	Міндетті ме?
құпиялылық саясаты	string	Құпиялылық саясатының URI.	Иә
Орындалу барысы	бүтін сан	0-100 пайыз аралығындағы мән аяқталды, мұнда 10 өңдеу шамамен 10%-ға аяқталғандығын білдіреді.	Иә
runCorrelationId	GUID	Әр сұрауға кіретін сұрау идентификаторы. Мұны қажет болған жағдайда сұраныспен байланыстыру үшін пайдалануға болады.	Иә
күй	string	`InProgress` тапсырма әлі өңделіп жатқанда қайтарылады. `Failed` серверде тапсырманы өңдеуде апатты мәселе болған кезде қайтарылады. Қате сипаттамасында көбірек мәліметтер болуы керек. `Finished` тапсырма ақаусыз сәтті аяқталған кезде қайтарылады. `FinishedWithErrors` тапсырма сәтті аяқталғанда қайтарылады, дегенмен бір немесе бірнеше ережелер қатесіз аяқталмады. Бұл сізге берілген есеп толық болмауы мүмкіндігін білдіретін сигнал болып табылады. Microsoft бэкендтегі осы мәселелер туралы біледі және диагностикалау және шешу үшін жұмыс істейді.	Иә
resultFileUris	жолдар массиві	Шығаруды тікелей жүктеуге мүмкіндік беретін URI мекенжайларының тізімі. Бастапқы талдауға арналған API қоңырауына қосылған бір файл болуы керек.	Жоқ. Бұл өңдеу аяқталған кезде ғана енгізіледі.
шығарылым жиынтығы	Шығарылым жиынтығы	Төменде көрсетілген сипаттар	Жоқ. Бұл өңдеу аяқталған кезде ғана енгізіледі.
issueSummary.criticalIssueCount	бүтін сан	Нәтижесінде сыни маңызы бар анықталған мәселелер саны	Иә
issueSummary.highIssueCount	бүтін сан	Нәтижесінде жоғары маңызы бар анықталған мәселелер саны	Иә
issueSummary.mediumIssueCount	бүтін сан	Нәтижесінде орташа маңызы бар анықталған мәселелер саны	Иә
issueSummary.lowIssueCount	бүтін сан	Нәтижесінде маңыздылығы төмен анықталған мәселелер саны	Иә
issueSummary.informationalIssueCount	бүтін сан	Нәтижесінде ақпараттық маңызы бар анықталған мәселелер саны	Иә

Мысал: жұмыс аяқталғаннан кейін күйін тексеру

Бұл мысалда нәтижесі аяқтау болып табылатын күйді тексеру қоңырауы жасалады.

Сұраныс

GET [Geographical URI]/api/status/aaaa0000-bb11-2222-33cc-444444dddddd&api-version=1.0
Accept: application/json
Content-Type: application/json; charset=utf-8
x-ms-correlation-id: aaaa0000-bb11-2222-33cc-444444dddddd
x-ms-tenant-id: aaaabbbb-0000-cccc-1111-dddd2222eeee

жауап

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":"aaaa0000-bb11-2222-33cc-444444dddddd","status":"Finished","issueSummary":
    {
        "informationalIssueCount":0,
        "lowIssueCount":0,
        "mediumIssueCount":302,
        "highIssueCount":30,
        "criticalIssueCount":0
    }
}

Сондай-ақ, келесіні қараңыз

Power Apps тексеру веб API пайдаланыңыз
Ережелер жинағының тізімін шығарып алыңыз
Ережелер тізімін шығарып алыңыз
Файлды жүктеп салыңыз
Талдауды шақыру

Бөлісу құралы: