İstek Hizmeti API'si hata kodları

Genel bakış

Microsoft Entra Doğrulanmış Kimliği, kimlik bilgilerini vermenizi ve doğrulamanızı sağlayan İstek Hizmeti REST API'sini içerir. Bu makalede İstek Hizmeti API'sinin hata kodları belirtildi.

Hata nesnesi

Önizleme sırasında İstek Hizmeti API'si aşağıdaki biçimde hatalar döndürdü.

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

Bu biçim, hem daha basit hata işlemeyi hem de sorun giderme için daha iyi desteği etkinleştirmek için aşağıdakine değiştirildi. Yeni biçimde, dış hata kodu ve ileti alanları standartlaştırılmış değerlere sahipken, nesne hataya innererror neyin neden olduğuyla ilgili ayrıntıları sağlar.

{
  "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"
    }
  }
}
Mülk Tür Açıklama
requestId dizgi Otomatik oluşturulan istek kimliği.
date tarih Hatanın zamanı.
mscv dizgi İç Microsoft kodu.
error Hatası Dış hata nesnesi

Hata türü

Nesne error artık geliştiriciler için daha kolay hata işlemeyi sağlamak için API Çağrısından döndürülen HTTP Durum Kodu ile eşleşir.

Mülk Tür Açıklama
code dizgi HTTP Durum Kodu ile eşleşen dönüş hata kodu.
message dizgi Döndürülen HTTP durum koduna da bağımlı olan standartlaştırılmış bir hata iletisi.
innererror Innererror Hataya neyin neden olduğu hakkında ayrıntılı bilgi sağlayın.

Hata kodları ve iletiler

Aşağıdakiler, döndürülen farklı HTTP durum kodlarıyla eşleyen olası üst düzey code değerlerdir.

HTTP Durum Kodu kod İleti
400 badRequest İstek geçersiz.
401 yetkisiz İstenen kaynak için kimlik doğrulaması gerekiyor
403 yasak Bu isteği yerine getirmek için eksik izinler.
404 notFound İstenen kaynak yok.
405 methodNotAllowed İstenen kaynakta istenen yönteme izin verilmiyor.
406 notAcceptable İstenen yanıt biçimi desteklenmiyor.
408 requestTimeout (İstekZaman Aşımı) İstek zaman aşımına uğradı.
409 anlaşmazlık Sunucu çakışması nedeniyle isteği karşılayamaz.
410 gitmiş İstenen kaynak artık kullanılamıyor.
411 contentLengthRequired İçerik Uzunluğu üst bilgisi eksik.
412 preconditionFailed Bu istek için önkoşul başarısız oldu.
413 payloadTooLarge Yük çok büyük.
414 uriTooLong URI çok uzun.
415 unsupportedMediaType Belirtilen medya türü desteklenmiyor.
416 rangeNotSatisfiable İstenen veri aralığı karşılanamıyor.
417 expectationFailed Beklenen üst bilgi karşılanamadı.
421 yanlış yönlendirilmişRequest Bu istek için yanıt oluşturulamıyor.
422 unprocessableEntity İstek semantik hatalar içeriyor.
423 Kilitli Kaynak veya hedef kaynak kilitli.
429 tooManyRequests Çok fazla istek var, daha sonra yeniden deneyin.
431 requestHeaderFieldsTooLarge İstek üst bilgisi alanı çok büyük.
beş yüz internalServerError Sunucuda genel bir hata oluştu.
501 notImplemented Sunucu istenen işlevi desteklemiyor.
502 badGateway Başka bir ağ geçidinden hatalı yanıt alındı.
503 serviceUnavailable Sunucu geçici olarak kullanılamıyor, lütfen daha sonra yeniden deneyin.
504 gatewayTimeout Başka bir ağ geçidinden alınan zaman aşımı.
507 insufficientStorage İstek için veri kaydedilemiyor.

İç hata türü

İç hata nesnesi, geçerli hatayı araştırmaya yardımcı olmak için geliştirici için yararlı olan hataya özgü ayrıntılar içerir.

{
  "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"
    }
  }
}
Mülk Tür Açıklama
code dizgi İç hata kodu. Hatanın türüne bağlı olarak standartlaştırılmış bir kod içerir
message dizgi İç hata iletisi. Hatanın ayrıntılı bir iletisini içerir. Bu örnekte, includeQRCode alanı yanlış türde.
target dizgi Opsiyonel. Hedef, istekte bu hataya neden olan alanı içerir. Bu alan isteğe bağlıdır ve hata türüne bağlı olarak mevcut olmayabilir.

İç hata kodları

Kod Açıklama
badOrMissingField İstekte doğrulama sorunları oluştuğunda döndürülür. target alanı, istekte soruna neden olan alanı içerir.
notFound İstemcinin istediği bir kaynak bulunamadığında döndürülür. target alanı, bulunmayan kaynak adını/kimliğini içerir.
tokenError JSON Web Belirteci (JWT) ve benzeri belirteçlerdeki doğrulama sorunları için döndürülür. target alanı, uygun olduğunda soruna neden olan belirteç adını içerir.
transientError İstemcinin isteği daha sonraki bir aşamada yeniden denemesi durumunda başarılı bir yanıt alabildiği tüm durumlar için döndürülür. Bu kodun döndürülürken sık karşılaşılan bir örnek http 429 kodu döndürülür.

Sonraki adımlar

  • Last updated on