Service API-hibakódok kérése

  • Cikk

Microsoft Entra Ellenőrzött azonosító tartalmazza a Kérelemszolgáltatás REST API-t, amely lehetővé teszi a hitelesítő adatok kiállítását és ellenőrzését. Ez a cikk a Kérelemszolgáltatás API hibakódjait ismerteti.

Hibaobjektum

A nyilvános előzetes verzióban a Request Service API a következő formátumban adott vissza hibákat.

{
  "requestId": "4bb6726f77af7623ab52962323016442",
  "date": "Thu, 28 Apr 2022 14:30:54 GMT",
  "mscv": "17ppwf3uxR10MfRR.1",
  "error": {
    "code": "client_request.invalid_include_qr_code",
    "message": "The request contains `includeQRCode`, but it is not boolean."
  }
}

Ez a formátum mostantól a következőre módosul, hogy egyszerűbb hibakezelést és jobb támogatást biztosítson a hibaelhárításhoz. Az új formátumban a külső hibakód és az üzenetmezők szabványosított értékekkel rendelkeznek, míg az innererror objektum részletesen ismerteti, hogy mi okozta a hibát.

{
  "requestId": "782628eb-503a-4978-84f2-d7c634f25b15",
  "date": "Fri, 29 Apr 2022 11:20:19 GMT",
  "mscv": "QbBLwF7XAp0dt4Lw.1",
  "error": {
    "code": "badRequest",
    "message": "The request is invalid.",
    "innererror": {
      "code": "badOrMissingField",
      "message": "The request contains `includeQRCode`, but it is not boolean.",
      "target": "includeQRCode"
    }
  }
}
Tulajdonság Type Description
requestId sztring Automatikusan létrehozott kérésazonosító.
date dátum: A hiba időpontja.
mscv sztring Belső Microsoft-kód.
error Hiba A külső hibaobjektum

Error type

Az error objektum most már megfelel az API-hívásból visszaadott HTTP-állapotkódnak, hogy megkönnyítse a fejlesztők számára a hibakezelést.

Tulajdonság Type Description
code sztring A HTTP-állapotkódnak megfelelő visszatérési hibakód.
message sztring Szabványosított hibaüzenet, amely a visszaadott HTTP-állapotkódtól is függ.
innererror Innererror Adjon meg részleteket arról, hogy mi okozta a hibát.

Hibakódok és üzenetek

Az alábbiakban azokat a lehetséges legfelső szintű code értékeket soroljuk fel, amelyek leképezik a különböző HTTP-állapotkódokat.

HTTP-állapotkód code message
400 badRequest A kérelem érvénytelen.
401 Jogosulatlan A kért erőforrás hitelesítést igényel
403 Tiltott Hiányzó engedélyek a kérés teljesítéséhez.
404 notFound A kért erőforrás nem létezik.
405 methodNotAllowed A kért metódus nem engedélyezett a kért erőforráson.
406 notAcceptable A kért válaszformátum nem támogatott.
408 requestTimeout A kérés túllépte az időkorlátot.
409 Konfliktus A kiszolgáló nem tudja teljesíteni a kérést kiszolgálóütközés miatt.
410 Elment A kért erőforrás már nem érhető el.
411 contentLengthRequired Hiányzik a Content-Length fejléc.
412 preconditionFailed A kérés előfeltétele nem sikerült.
413 payloadTooLarge A hasznos adat túl nagy.
414 uriTooLong Az URI túl hosszú.
415 nem támogatottMediaType A megadott médiatípus nem támogatott.
416 rangeNotSatisfiable A kért adattartomány nem teljesíthető.
417 expectationFailed A Várakozás fejléc nem felelt meg.
421 misdirectedRequest Nem sikerült választ adni ehhez a kéréshez.
422 unprocessableEntity A kérelem szemantikai hibákat tartalmaz.
423 Zárt A forrás- vagy célerőforrás zárolva van.
429 tooManyRequests Túl sok kérés, próbálkozzon újra később.
431 requestHeaderFieldsTooLarge A kérelem fejlécmezője túl nagy.
500 internalServerError Általános hiba történt a kiszolgálón.
501 notImplemented A kiszolgáló nem támogatja a kért függvényt.
502 badGateway egy másik átjárótól kapott rossz válasz.
503 serviceUnavailable A kiszolgáló átmenetileg nem érhető el, próbálkozzon újra később.
504 gatewayTimeout Egy másik átjárótól kapott időtúllépés.
507 insufficientStorage A kérelem adatai nem menthetők.

Belső hibatípus

A belső hibaobjektum a fejlesztő számára hasznos hibaspecifikus részleteket tartalmaz az aktuális hiba kivizsgálásához.

{
  "requestId": "782628eb-503a-4978-84f2-d7c634f25b15",
  "date": "Fri, 29 Apr 2022 11:20:19 GMT",
  "mscv": "QbBLwF7XAp0dt4Lw.1",
  "error": {
    "code": "badRequest",
    "message": "The request is invalid.",
    "innererror": {
      "code": "badOrMissingField",
      "message": "The request contains `includeQRCode`, but it is not boolean.",
      "target": "includeQRCode"
    }
  }
}
Tulajdonság Type Description
code sztring A belső hibakód. A hiba típusa alapján szabványosított kódot tartalmaz
message sztring A belső hibaüzenet. A hiba részletes üzenetét tartalmazza. Ebben a példában a includeQRCode mező nem megfelelő típusú.
target sztring Opcionális. A cél a hibát okozó kérés mezőjét tartalmazza. Ez a mező nem kötelező, és a hiba típusától függően előfordulhat, hogy nem jelenik meg.

Belső hibakódok

Code Leírás
badOrMissingField a kérés érvényesítési problémái esetén adja vissza. A target mező a problémát okozó kérelemben szereplő mezőt tartalmazza.
notFound akkor lesz visszaadva, ha az ügyfél által kért erőforrás nem található. A target mező tartalmazza a nem található erőforrásnevet/azonosítót.
tokenError a JWT-hez és a kedvelésekhez hasonló jogkivonatokkal kapcsolatos érvényesítési problémák esetén. A target mező tartalmazza a problémát okozó jogkivonat nevét, ha van ilyen.
transientError minden olyan esetben, amikor az ügyfél sikeres választ kaphat, ha egy későbbi szakaszban újrapróbálkozza a kérést. A kód visszaadásának gyakori példája a HTTP 429-kód visszaadása

További lépések