הפעלת ניתוח
הפעלת משימת ניתוח מתבצעת על-ידי שליחת בקשת POST לנתיב analyze. הפעלת תהליך ניתוח עשויה בדרך כלל להימשך יותר מדקה. ה- API מבצע תחילה אימות בסיסי, מפעיל את הבקשה בקצה העורפי על-ידי שליחת משימה ולאחר מכן מגיב עם קוד מצב של 202 וכותרת עליונה של Location או עם פרטי השגיאה המתאימים. ערך הכותרת העליונה של Location הוא כתובת URL שבה ניתן להשתמש כדי לבדוק את מצב הבקשה ולהשיג את כתובות ה- URL של התוצאות. באמצעות הפעולה POST קיימות אפשרויות שונות להתאמת המשימה על בסיס הקריטריונים שלך, כגון רשימת כללים או ערכות כללים, קבצים שלא צריכים להיכלל בניתוח ועוד. ניתן להפעיל את הניתוח באמצעות הפקודה הבאה: [Geographical URL]/api/analyze?api-version=1.0.
הערה
מומלץ להמתין בין 15 ל- 60 שניות בין בדיקות מצב. הפעלת הניתוח נמשכת בדרך כלל בין דקה אחת ל- 5 דקות.
API זה מחייב שימוש באסימון OAuth.
כותרות
| שם | סוג | ערך צפוי | נדרש? |
|---|---|---|---|
| Authorization | string | האסימון הנושא של OAuth 1 עם טענת מזהה יישום של Azure Active Directory (AAD). | כן |
| x-ms-tenant-id | GUID | מזהה הדייר עבור הבקשה. | כן |
| x-ms-correlation-id | GUID | המזהה עבור הפעלת הניתוח. עליך לספק את אותו מזהה עבור כל הביצוע (העלאה, ניתוח, מצב). | כן |
| Accept | object | application/json, application/x-ms-sarif-v2 |
כן |
| Accept-Language | string | קודי השפות (למשל, he-IL). ברירת המחדל היא en-US. אם סופקו כמה שפות, השפה הראשונה תהיה הראשית. עם זאת, ייכללו כל התרגומים (אם השפה נתמכת). | לא |
גוף
אפשרויות נפוצות:
| מאפיין | סוג | ערך צפוי | נדרש? |
|---|---|---|---|
| sasUriList | array of strings | רשימת מזהי URI שמספקת לשירות גישה להורדת פתרון אחד, קובץ zip שמכיל קבצי פתרונות מרובים, או חבילה. | כן |
| ruleSets | array of custom | 0 או יותר | לא |
| ruleSets.id | guid | המזהה של ערכת הכללים, שניתן למצוא על ידי ביצוע שאילתה ב- API של ערכת הכללים. | לא, אך מומלץ בדרך כלל להשתמש בו. עליך להשתמש במאפיין זה או ב- ruleCodes. |
| ruleCodes.code | string | המזהה של הכלל הרצוי, שניתן למצוא על ידי ביצוע שאילתה ב- API של הכלל וערכת הכללים. | לא. עליך להשתמש במאפיין זה או ב- ruleSets. |
| fileExclusions | array of strings | רשימה של שמות קבצים או דפוסי שמות קבצים שלא צריכים להיכלל. קיימת תמיכה בשימוש ב- * כתו כללי בהתחלה ו/או בסוף של שם קובץ ( למשל, *jquery.dll ו- *jquery*). | לא |
תגובות צפויות
| קוד מצב HTTP | תרחיש | תוצאה |
|---|---|---|
| 202 | בקשת הניתוח התקבלה, וה- URI של בדיקת המצב הוחזר לכותרת העליונה של Location |
אין גוף תוצאה |
| 400 | נשלח קובץ שאינו zip, נשלחו פרמטרים שגויים או נכלל קובץ עם וירוס | אין גוף תוצאה |
| 409 | נשלחה בקשה עם ערך כותרת עליונה כפול של x-ms-correlation-id |
אין גוף תוצאה |
כותרות עליונות צפויות של תגובה
| שם | סוג | ערך צפוי | נדרש? |
|---|---|---|---|
| Location | Uri | ה- URL שבו יש להשתמש בשאילתות עבור המצב הנוכחי ולהשגת התוצאות | כן |
דוגמה: הפעלת ניתוח
זוהי דוגמה להפעלת משימת ניתוח עם ערכת הכללים AppSource Certification וקובץ אחד, כאשר לא נכללים קבצים ששמם מכיל את הטקסט 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
אחזור רשימת ערכות הכללים
אחזור רשימת הכללים
העלאת קובץ
בדיקת מצב הניתוח