שתף באמצעות

טיפול בשגיאות REST API

  • מאמר

תגובות שגיאת HTTP מחולקות לשתי קטגוריות:

  • שגיאת לקוח (ברמת קוד 400) – הלקוח שלח בקשה לא חוקית או שהבקשה אינה בהתאם להגדרות.
  • שגיאת שרת (ברמת 500) – השרת לא הצליח למלא את הבקשה באופן זמני או שאירעה שגיאת שרת. נסה לשלוח שוב את בקשת HTTP.

קודי השגיאה המפורטים בטבלה הבאה עשויים להיות מוחזרים על-ידי פעולה בכל אחד Microsoft Defender עבור נקודת קצה API.

  • בנוסף לקוד השגיאה, כל תגובה לשגיאה מכילה הודעת שגיאה, שיכולה לעזור בפתרון הבעיה.
  • ההודעה היא טקסט ללא תשלום שניתן לשנותו.
  • בתחתית הדף, תוכל למצוא דוגמאות תגובה.

חל על:

רוצה לחוות את Defender עבור נקודת קצה? הירשם לקבלת גירסת ניסיון ללא תשלום.

קוד שגיאה קוד מצב HTTP ההודעה
בקשה ל- BadRequest הורדות ב- BadRequest (400) הודעת שגיאה כללית של בקשה שגויה.
ODataError הורדות ב- BadRequest (400) שאילתת URI לא חוקית של OData (צוינה השגיאה הספציפית).
תפוקה לא חוקית הורדות ב- BadRequest (400) קלט לא חוקי {הקלט הלא חוקי}.
InvalidRequestBody הורדות ב- BadRequest (400) גוף בקשה לא חוקי.
InvalidHashValue הורדות ב- BadRequest (400) ערך ה- Hash {ה- Hash הלא חוקי} אינו חוקי.
InvalidDomainName הורדות ב- BadRequest (400) שם התחום {התחום הלא חוקי} אינו חוקי.
InvalidIpAddress הורדות ב- BadRequest (400) כתובת ה- IP {ה- IP הלא חוקית} אינה חוקית.
ערך לא חוקי הורדות ב- BadRequest (400) כתובת ה- URL {כתובת ה- URL הלא חוקית} אינה חוקית.
MaximumBatchSizeExceeded הורדות ב- BadRequest (400) אירעה חריגה מגודל האצווה המרבי. התקבל: {batch size received}, מותר: {batch size allowed}.
MissingRequiredParameter הורדות ב- BadRequest (400) הפרמטר {הפרמטר החסר} חסר.
OsPlatformNotSupported הורדות ב- BadRequest (400) פלטפורמת מערכת ההפעלה {פלטפורמת מערכת ההפעלה של הלקוח} אינה נתמכת עבור פעולה זו.
ClientVersionNotSupported הורדות ב- BadRequest (400) {הפעולה המבוקשת} נתמכת בגירסה לקוח {גירסת לקוח נתמכת} ומעלה.
מורשית לא מורשה (401) לא מורשה (כותרת הרשאה לא חוקית או שפג תוקפה).
אסור אסור (403) אסור (אסימון חוקי אך הרשאה לא מספיקה עבור הפעולה).
הזנה לא זמינה אסור (403) תכונת הדייר אינה זמינה.
פעולה אסורה אסור (403) {הפעולה אסורה והסיבה}.
NotFound לא נמצא (404) הודעת שגיאה כללית לא נמצאה.
ResourceNotFound לא נמצא (404) המשאב {המשאב המבוקש} לא נמצא.
מדיManyRequests בקשות רבות מדי (429) התגובה מייצגת הגעה למגבלת המיכסה לפי מספר בקשות או לפי CPU.
InternalServerErError שגיאת שרת פנימית (500) (אין הודעת שגיאה, נסה שוב לבצע את הפעולה.)

ויסות

לקוח HTTP עשוי לקבל שגיאת 'בקשות רבות מדי (429)' כאשר מספר בקשות HTTP במסגרת זמן נתונה חורג ממספר הקריאות המותר לכל API.

על לקוח ה- HTTP להשהות את השליחה מחדש של בקשות HTTPS נוספות ולאחר מכן לשלוח אותן באופן תואם למגבלות התעריף. הודעה Retry-After בכותרת התגובה המציינת כמה זמן להמתין (בשניות) לפני ביצוע בקשה חדשה

התעלמות מהתגובה של 429 או ניסיון לשלוח מחדש בקשות HTTP במסגרת זמן קצרה יותר מעניקה החזרה של קוד השגיאה 429.

הפרמטרים של הגוף הם תלויי רישיות

הפרמטרים של גוף ההודעה שנשלחו הם כעת תלויי רישיות.

אם אתה נתקל בשגיאות InvalidRequestBody או MissingRequiredParameter , ייתכן שהסיבה לכך היא אות רישית או אות קטנה שגויה של פרמטר.

סקור את דף התיעוד של ה- API ובדוק שהפרמטרים שנשלחו תואמים לדוגמה הרלוונטית.

מזהה בקשת מתאם

כל תגובה לשגיאה מכילה פרמטר מזהה ייחודי למעקב.

שם המאפיין של פרמטר זה הוא "target".

בעת יצירת קשר לגבי שגיאה, צירוף מזהה זה עוזר לך למצוא את הגורם לבעיה.

דוגמאות

{
    "error": {
        "code": "ResourceNotFound",
        "message": "Machine 123123123 was not found",
        "target": "43f4cb08-8fac-4b65-9db1-745c2ae65f3a"
    }
}

{
    "error": {
        "code": "InvalidRequestBody",
        "message": "Request body is incorrect",
        "target": "1fa66c0f-18bd-4133-b378-36d76f3a2ba0"
    }
}

עצה

האם ברצונך לקבל מידע נוסף? Engage עם קהילת האבטחה של Microsoft בקהילת הטכנולוגיה שלנו: Microsoft Defender עבור נקודת קצה Tech Community.