Талдау күйін тексеру
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 | Өтінім идентификаторын талап ете отырып Microsoft Entra , OAuth 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/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
Response
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 тексеру құралының веб-API интерфейсін пайдалану
Ережелер жинақтарының тізімін шығарып алу
Ережелер тізімін шығарып алу
Файлды кері қотару
Талдауды шақыру