Hantera REST API-fel

Artikel
05/02/2024

HTTP-felsvar är indelade i två kategorier:

Klientfel (400-kodsnivå) – klienten skickade en ogiltig begäran eller så är begäran inte i enlighet med definitionerna.
Serverfel (500-nivå) – servern kunde tillfälligt inte uppfylla begäran eller så uppstod ett serverfel. Försök att skicka HTTP-begäran igen.

Felkoderna som anges i följande tabell kan returneras av en åtgärd på någon av Microsoft Defender för Endpoint API:er.

Förutom felkoden innehåller varje felsvar ett felmeddelande som kan hjälpa dig att lösa problemet.
Meddelandet är en fritext som kan ändras.
Längst ned på sidan finns svarsexempel.

Gäller för:

Vill du uppleva Microsoft Defender för Endpoint? Registrera dig för en kostnadsfri utvärderingsversion.

Felkod	HTTP-statuskod	Meddelande
BadRequest	BadRequest (400)	Allmänt felmeddelande om felaktig begäran.
ODataError	BadRequest (400)	Ogiltig OData-URI-fråga (det specifika felet har angetts).
InvalidInput	BadRequest (400)	Ogiltiga indata {ogiltiga indata}.
InvalidRequestBody	BadRequest (400)	Ogiltig begärandetext.
InvalidHashValue	BadRequest (400)	Hashvärdet {den ogiltiga hashen} är ogiltigt.
InvalidDomainName	BadRequest (400)	Domännamnet {den ogiltiga domänen} är ogiltigt.
InvalidIpAddress	BadRequest (400)	IP-adressen {den ogiltiga IP-adressen} är ogiltig.
InvalidUrl	BadRequest (400)	URL:en {den ogiltiga URL:en} är ogiltig.
MaximumBatchSizeExceeded	BadRequest (400)	Maximal batchstorlek har överskridits. Mottaget: {batchstorlek mottagen}, tillåten: {batchstorlek tillåten}.
MissingRequiredParameter	BadRequest (400)	Parametern {parametern som saknas} saknas.
OsPlatformNotSupported	BadRequest (400)	OS-plattformen {klientens OS-plattform} stöds inte för den här åtgärden.
ClientVersionNotSupported	BadRequest (400)	{Den begärda åtgärden} stöds i klientversionen {klientversion som stöds} och senare.
Obehörig	Obehörig (401)	Obehörig (ogiltigt eller utgånget auktoriseringshuvud).
Ej tillåtet	Förbjudet (403)	Förbjudet (giltig token men otillräcklig behörighet för åtgärden).
DisabledFeature	Förbjudet (403)	Klientfunktionen är inte aktiverad.
Otillåtenåtgärd	Förbjudet (403)	{den otillåtna åtgärden och orsaken}.
NotFound	Hittades inte (404)	Allmänt felmeddelande hittades inte.
ResourceNotFound	Hittades inte (404)	Resursen {den begärda resursen} hittades inte.
TooManyRequests	För många begäranden (429)	Svaret representerar att nå kvotgränsen antingen efter antal begäranden eller efter CPU.
InternalServerError	Internt serverfel (500)	(Inget felmeddelande, försök igen.)

Strypning

HTTP-klienten kan få felet "För många begäranden (429)" när antalet HTTP-begäranden inom en viss tidsram överskrider det tillåtna antalet anrop per API.

HTTP-klienten bör fördröja inskickningen av ytterligare HTTPS-begäranden och sedan skicka dem på ett sätt som uppfyller hastighetsbegränsningarna. En Retry-After i svarshuvudet som anger hur länge du ska vänta (i sekunder) innan du gör en ny begäran

Om du ignorerar 429-svaret eller försöker skicka HTTP-begäranden på nytt inom en kortare tidsperiod returneras felkoden 429.

Brödtextparametrar är skiftlägeskänsliga

De inskickade brödtextparametrarna är för närvarande skiftlägeskänsliga.

Om du får felen InvalidRequestBody eller MissingRequiredParameter kan det bero på fel parameterhuvudstad eller gemener.

Granska api-dokumentationssidan och kontrollera att de inskickade parametrarna matchar det relevanta exemplet.

ID för korrelationsbegäran

Varje felsvar innehåller en unik ID-parameter för spårning.

Egenskapsnamnet för den här parametern är "target".

När du kontaktar oss om ett fel kan du hitta rotorsaken till problemet genom att koppla det här ID:t.

Exempel

{
    "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"
    }
}

Tips

Vill du veta mer? Engage med Microsofts säkerhetscommunity i vår Tech Community: Microsoft Defender för Endpoint Tech Community.

Dela via