Sdílet prostřednictvím


Zpracování chyb rozhraní REST API

Odpovědi na chyby HTTP jsou rozdělené do dvou kategorií:

  • Chyba klienta (úroveň 400 kódu) – klient odeslal neplatný požadavek nebo požadavek neodpovídá definicím.
  • Chyba serveru (na úrovni 500) – server dočasně nesplnil požadavek nebo došlo k chybě serveru. Zkuste požadavek HTTP odeslat znovu.

Kódy chyb uvedené v následující tabulce mohou být vráceny operací v libovolném z rozhraní API Microsoft Defender for Endpoint.

  • Kromě kódu chyby obsahuje každá chybová odpověď chybovou zprávu, která může pomoct problém vyřešit.
  • Zpráva je volný text, který lze změnit.
  • V dolní části stránky najdete příklady odpovědí.

Platí pro:

Chcete používat Defender pro Endpoint? Zaregistrujte se a získejte bezplatnou zkušební verzi,

Kód chyby Stavový kód HTTP Zpráva
BadRequest BadRequest (400) Obecná chybová zpráva Chybný požadavek
Chyba OData BadRequest (400) Neplatný dotaz URI OData (je zadána konkrétní chyba).
InvalidInput BadRequest (400) Neplatný vstup {neplatný vstup}.
InvalidRequestBody BadRequest (400) Neplatný text požadavku.
InvalidHashValue BadRequest (400) Hodnota hash {neplatná hodnota hash} je neplatná.
InvalidDomainName BadRequest (400) Název domény {neplatná doména} je neplatný.
InvalidIpAddress BadRequest (400) IP adresa {neplatná IP adresa} je neplatná.
Neplatná adresa BadRequest (400) Adresa URL {neplatná adresa URL} je neplatná.
MaximumBatchSizeExceeded BadRequest (400) Byla překročena maximální velikost dávky. Přijato: {batch size received}, povoleno: {batch size allowed}.
MissingRequiredParameter BadRequest (400) Chybí parametr {chybějící parametr}.
OsPlatformNotSupported BadRequest (400) Platforma operačního systému {the client OS Platform} se pro tuto akci nepodporuje.
ClientVersionNotSupported BadRequest (400) {Požadovaná akce} je podporována ve verzi klienta {podporovaná verze klienta} a vyšší.
Neoprávněným Neautorizováno (401) Neautorizováno (neplatná nebo prošlá autorizační hlavička)
Zakázáno Zakázáno (403) Zakázáno (platný token, ale nedostatečná oprávnění k akci)
DisabledFeature Zakázáno (403) Funkce tenanta není povolená.
NepovolenoOperace Zakázáno (403) {nepovolené operace a důvod}.
Nenalezeno Nenalezena (404) Obecná chybová zpráva Nenalezena.
ResourceNotFound Nenalezena (404) Prostředek {požadovaný prostředek} se nenašel.
TooManyRequests Příliš mnoho požadavků (429) Odpověď představuje dosažení limitu kvóty buď počtem požadavků, nebo procesorem.
InternalServerError Vnitřní chyba serveru (500) (Žádná chybová zpráva, zkuste operaci zopakovat.)

Omezení

Klient HTTP může obdržet chybu Příliš mnoho požadavků (429) v případě, že počet požadavků HTTP v daném časovém rámci překročí povolený počet volání na rozhraní API.

Klient HTTP by měl odložit opětovné odeslání dalších požadavků HTTPS a pak je odeslat způsobem, který vyhovuje omezením rychlosti. Retry-After v hlavičce odpovědi označující, jak dlouho se má čekat (v sekundách) před vytvořením nového požadavku.

Ignorování odpovědi 429 nebo pokus o opětovné odeslání požadavků HTTP v kratším časovém rámci vrátí kód chyby 429.

V parametrech textu se rozlišují velká a malá písmena.

V odeslaných parametrech textu se v současné době rozlišují velká a malá písmena.

Pokud dojde k chybám InvalidRequestBody nebo MissingRequiredParameter , může to být způsobeno chybným velkým nebo velkým písmenem parametru.

Projděte si stránku dokumentace k rozhraní API a zkontrolujte, jestli odeslané parametry odpovídají příslušnému příkladu.

ID žádosti o korelaci

Každá odpověď na chybu obsahuje jedinečný parametr ID pro sledování.

Název vlastnosti tohoto parametru je "target".

Když nás budete kontaktovat kvůli chybě, pomůže vám připojení tohoto ID najít původní příčinu problému.

Příklady

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

Tip

Chcete se dozvědět více? Engage s komunitou Microsoft Security v naší technické komunitě: Microsoft Defender for Endpoint Tech Community.