Condividi tramite

Codici di errore dell'API del servizio di richiesta

  • Articolo

Microsoft Entra Verified ID include l'API REST del servizio di richiesta che consente di rilasciare e verificare le credenziali. Questo articolo specifica i codici di errore per l'API del servizio di richiesta.

Oggetto Error

Durante l'anteprima pubblica, l'API del servizio di richiesta ha restituito errori nel formato seguente.

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

Questo formato viene ora modificato nel modo seguente per consentire la gestione degli errori più semplice e un supporto migliore per la risoluzione dei problemi. Nel nuovo formato, l'errore esterno codice e i campi messaggio hanno valori standardizzati mentre l'oggetto innererror fornisce informazioni dettagliate su ciò che ha causato l'errore.

{
  "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"
    }
  }
}
Proprietà Digitare Descrizione
requestId corda ID richiesta generato automaticamente.
date dattero Ora dell'errore.
mscv corda Codice Microsoft interno.
error errore Oggetto errore esterno

Tipo di errore

L'oggetto error corrisponde ora al codice di stato HTTP restituito dalla chiamata API per semplificare la gestione degli errori per gli sviluppatori.

Proprietà Digitare Descrizione
code corda Codice di errore restituito corrispondente al codice di stato HTTP.
message corda Messaggio di errore standardizzato che dipende anche dal codice di stato HTTP restituito.
innererror Innererror Specificare i dettagli su ciò che ha causato l'errore.

Codici di errore e messaggi

Di seguito sono riportati i possibili valori di livello superiore code mappati ai diversi codici di stato HTTP restituiti.

Codice di stato HTTP codice Messaggio
400 badRequest La richiesta non è valida.
401 non autorizzato La risorsa richiesta richiede l'autenticazione
403 vietato Autorizzazioni mancanti per soddisfare questa richiesta.
404 notFound La risorsa richiesta non esiste.
405 methodNotAllowed Il metodo richiesto non è consentito nella risorsa richiesta.
406 notAcceptable Formato di risposta richiesto non supportato.
408 requestTimeout Timeout della richiesta.
409 conflitto Il server non può soddisfare la richiesta a causa di un conflitto del server.
410 andato La risorsa richiesta non è più disponibile.
411 contentLengthRequired Intestazione Content-Length mancante.
412 precondizioneFailed Precondizione per questa richiesta non riuscita.
413 payloadTooLarge Il payload è troppo grande.
414 uriTooLong L'URI è troppo lungo.
415 unsupportedMediaType Il tipo di supporto specificato non è supportato.
416 rangeNotSatisfiable L'intervallo di dati richiesto non può essere soddisfatto.
417 expectationFailed Impossibile soddisfare l'intestazione Prevista.
421 misdirectedRequest Impossibile produrre una risposta per questa richiesta.
422 unprocessableEntity La richiesta contiene errori semantici.
423 bloccato La risorsa di origine o di destinazione è bloccata.
429 tooManyRequests Troppe richieste, riprovare più tardi.
431 requestHeaderFieldsTooLarge Il campo di intestazione della richiesta è troppo grande.
500 internalServerError Si è verificato un errore generico nel server.
501 notImplemented Il server non supporta la funzione richiesta.
502 badGateway risposta non valida ricevuta da un altro gateway.
503 serviceUnavailable Il server è temporaneamente non disponibile. Riprovare più tardi.
504 gatewayTimeout Timeout ricevuto da un altro gateway.
507 insufficientStorage Impossibile salvare i dati per la richiesta.

Tipo di errore interno

L'oggetto errore interno contiene dettagli specifici dell'errore utili per lo sviluppatore per analizzare l'errore corrente.

{
  "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"
    }
  }
}
Proprietà Digitare Descrizione
code corda Codice di errore interno. Contiene un codice standardizzato, in base al tipo di errore
message corda Messaggio di errore interno. Contiene un messaggio dettagliato dell'errore. In questo esempio il campo includeQRCode è di tipo errato.
target corda Opzionale. La destinazione contiene il campo nella richiesta che causa questo errore. Questo campo è facoltativo e potrebbe non essere presente, a seconda del tipo di errore.

Codici di errore interni

Codice Descrizione
badOrMissingField restituito quando si verificano problemi di convalida nella richiesta. Il campo target contiene il campo nella richiesta che causa il problema.
notFound restituito quando non viene trovata una risorsa che il client richiede. Il campo target contiene il nome o l'ID della risorsa non trovato.
tokenError restituito per eventuali problemi di convalida nei token, ad esempio token JSON Web (JWT) e simili. Il campo target contiene il nome del token che causa il problema, se applicabile.
transientError restituito per tutti i casi in cui il client potrebbe essere in grado di ottenere una risposta con esito positivo se ritenta la richiesta in una fase successiva. Un esempio comune di quando viene restituito questo codice è quando viene restituito un codice HTTP 429

Passaggi successivi