בדיקת מצב הניתוח

כתובת URL מוחזרת כחלק מהכותרת העליונה של Location בתגובה לבקשה ל- API של analyze. יש להשתמש בה לביצוע שאילתה דרך GET של HTTP עבור מצב משימת הניתוח. לאחר סיום משימת הניתוח, גוף התגובה יכלול את כתובת ה- URL או רשימה של כתובות URL שבהן ניתן להוריד את פלט התוצאות. המשך לבצע קריאות ל- URI זה עד שיוחזר קוד מצב HTTP של 200. בזמן שהמשימה עדיין פועלת, קוד מצב HTTP של 202 יוחזר עם הכותרת העליונה של Location שמכילה את אותו URI שהוחזר מ- analyze. לאחר שתוחזר תגובה של 200, המאפיין resultFileUris יכלול את המיקום היחיד או את רשימת המיקומים להורדת הפלט, שכלול בקובץ zip. בקובץ ה- zip להורדה כלול קובץ בתבנית Static Analysis Results Interchange Format ‏(SARIF) גירסה 2, שהוא קובץ בתבנית JSON שמכיל את תוצאות הניתוח. גוף התגובה יכיל אובייקט IssueSummary שמכיל סיכום של ספירת הבעיות שנמצאו.

הערה

מומלץ להמתין בין 15 ל- 60 שניות בין בדיקות מצב. הפעלת הניתוח נמשכת בדרך כלל בין דקה אחת ל- 5 דקות.
‏API זה מחייב שימוש באסימון OAuth אשר חייב להיות אסימון עבור אותו יישום לקוח שהפעיל את משימת הניתוח.

כותרות עליונות

שם סוג ערך צפוי נדרש?
Authorization string האסימון הנושא של OAuth 1 עם טענת מזהה יישום של AAD. כן
x-ms-tenant-id GUID מזהה הדייר עבור הבקשה. כן
x-ms-correlation-id GUID המזהה עבור הפעלת הניתוח. עליך לספק את אותו מזהה עבור כל הביצוע (העלאה, ניתוח, מצב). כן

תגובות צפויות

קוד מצב HTTP תרחיש תוצאה
200 נמצאה תוצאה אחת או יותר עיין בדוגמה שלהלן. תוחזר תוצאה אחת.
202 עדיין מעבד עיין בדוגמה שלהלן. תוחזר תוצאה אחת.
403 אסור המבקש אינו זהה ליוזם הבקשה לניתוח.
404 לא נמצא לא ניתן למצוא את בקשת הניתוח עם ההפניה שסופקה בכתובת ה- URL.

כותרות עליונות צפויות של תגובה

שם סוג ערך צפוי נדרש?
מיקום uri ה- URI שבו יש להשתמש בשאילתות עבור המצב הנוכחי ולהשגת התוצאות כן

גוף התגובה הצפוי

הטבלה הבאה מפרטת את מבנה התגובה עבור כל בקשה (תגובת HTTP של 200 או 202 בלבד).

מאפיין סוג ערך צפוי נדרש?
privacyPolicy string ה- URI של מדיניות הפרטיות. כן
progress int ערך אחוז השלמה שנע בין 0-100, כאשר 10 פירושו שהעיבוד הושלם בשיעור של כ- 10%. כן
runCorrelationId GUID מזהה הבקשה שכלול בכל בקשה. ניתן להשתמש בו כדי להתאים לבקשה, במידת הצורך. כן
status string InProgress מוחזר כאשר המשימה עדיין נמצאת בעיבוד. Failed מוחזר כאשר אירעה בעיה קטסטרופלית בעיבוד המשימה בשרת. מאפיין השגיאה אמור לכלול פרטים נוספים. Finished מוחזר כאשר המשימה הושלמה בהצלחה ללא בעיות. FinishedWithErrors מוחזר כאשר המשימה הושלמה בהצלחה, אך כלל אחד או יותר הושלמו עם שגיאה. זהו אות שמאפשר לך לדעת שייתכן שהדוח אינו שלם. ‏Microsoft מודעת לבעיות אלו בקצה העורפי, והיא תפעל כדי לאבחן אותן ולטפל בהן. כן
resultFileUris array of strings רשימת מזהי 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
    }
}

למידע נוסף

שימוש ב- API של אינטרנט של בודק Power Apps
אחזור רשימת ערכות הכללים
אחזור רשימת הכללים
העלאת קובץ
הפעלת ניתוח