Problemen met de gegevensexport-API oplossen
Gebruik dit onderwerp om veelvoorkomende foutmeldingen van de gegevensexport-API te
interpreteren en voor elke fout de meest waarschijnlijke oorzaak en oplossing te achterhalen.
Elke foutmelding bevat een
code, een message en een numerieke statusCode; de waarde van de code geeft de specifieke voorwaarde aan.Fouten bij authenticatie en autorisatie
| Foutcode | Waarschijnlijke oorzaak | Wat u kunt proberen |
|---|---|---|
ERR_INVALID_APIKEY (401) |
De x-api-key koptekst ontbreekt, is onjuist opgebouwd, is verlopen of is verwijderd. Dit treedt
ook kortstondig op (doorgaans minder dan één minuut) onmiddellijk nadat een sleutel
is aangemaakt of gewijzigd, voordat de nieuwe sleutel wordt geregistreerd. |
Controleer of het verzoek de koptekst x-api-key bevat met de volledige waarde van de API-sleutel. Controleer in Account Administration of de sleutel nog steeds bestaat en niet is verlopen. Indien de sleutel zojuist is
aangemaakt of vernieuwd, wacht dan één minuut en probeer het opnieuw. |
ERR_UNAUTHORIZED_PRINTERS (403) |
Het verzoek bevat één of meer printerId -waarden waartoe de API-sleutel geen toegang heeft. |
Roep /printers met dezelfde API-sleutel aan om precies te zien welke printers beschikbaar zijn,
en dien het verzoek vervolgens opnieuw in met uitsluitend die printer-ID’s. |
ERR_TENANT_NOT_FOUND (404) |
De API-sleutel wordt herkend, maar is niet gekoppeld aan een actief account. Dit kan gebeuren als een account is verwijderd of onjuist is geconfigureerd. | Neem contact op met uw RICOH-accountmanager om te controleren of uw tenant actief is en of de API-sleutel daaraan is gekoppeld. |
Fouten bij de validatie van parameters (400 Ongeldig verzoek)
Elke fout bij de validatie van een parameter levert een 400-statuscode op. De codewaarde geeft het specifieke probleem aan.
| Foutcode | Waarschijnlijke oorzaak | Wat u kunt proberen |
|---|---|---|
ERR_MISSING_PRINTER_ID |
Het verzoek bevatte geen printerId -waarden. Er is ten minste één vereist voor /jobs, /printer-states en /printer-interventions. |
Toevoeg ten minste één queryparameter printerId toe. Herhaal de parameter om meerdere printers op te nemen. |
ERR_INVALID_PRINTER_ID_FORMAT |
De waarde van printerId is geen geldige UUID. |
Controleer of de waarde overeenkomt met het antwoord van /printers. Veelvoorkomende fouten zijn onder meer extra witruimte, ontbrekende tekens of het
invoegen van de naam van de printer in plaats van het printer-ID. |
ERR_INVALID_TIMEZONE |
De timezone-waarde ontbreekt of is geen geldige IANA-tijdzone-identificatie. |
Gebruik een op regio gebaseerde identificatiecode, zoals America/Denver of Europe/Bucharest. Afkortingen van drie letters, zoals MST of EST, worden niet geaccepteerd. Op de interactieve documentatiepagina is een lijst met
alle toegestane waarden te vinden. |
ERR_INVALID_DATE_FORMAT |
De waarde van startDateTime of endDateTime is niet overeenkomend met de verwachte notatie. |
Gebruik de notatie JJJJ-MM-DDTHH:MM:SS, eventueel met het achtervoegsel .sss voor milliseconden. Vermeld geen UTC-verschuiving of het achtervoegsel Z; de tijdzone wordt afzonderlijk opgegeven in de parameter tijdzone. |
ERR_INVALID_DATE_RANGE |
startDateTime is gelijk aan of later dan endDateTime. |
Controleer of startDateTime vroeger is dan endDateTime in de opgegeven tijdzone. |
ERR_DATE_RANGE_EXCEEDED |
De periode tussen startDateTime en endDateTime overschrijdt het maximaal toegestane bereik. |
Verminder de omvang van het gevraagde tijdvenster. Zie Omgaan met responslimieten van de gegevensexport-API voor richtlijnen inzake chunking. |
ERR_INVALID_JOB_STATE |
De waarde van jobState is geen van de toegestane waarden. |
Gebruik een van de volgende termen: wordt afgedrukt, afgedrukt, afgebroken of voltooid. Opmerking: onder completed vallen zowel printed als aborted taken. |
ERR_INVALID_STATE_CATEGORY |
De waarde van stateCategory behoort niet tot de toegestane waarden. |
Kies een van de volgende opties: up, down of idle. |
ERR_INVALID_LANGUAGE |
De language-waarde die aan /printer-interventions is doorgegeven, behoort niet tot de toegestane waarden. |
Gebruik een van de volgende talen: en, de, ja, it, fr of es. Deze foutmelding betekent dat de code zelf is afgewezen; een code die wel wordt
geaccepteerd maar waarvoor geen vertaling voor een bepaalde omschrijving beschikbaar
is, leidt niet tot een fout, omdat de API die omschrijving in plaats daarvan in het
Engels retourneert. |
ERR_INVALID_BOOLEAN_PARAM |
De parameter currentState of stateCategoryOnly heeft een andere waarde dan true of false. |
Gebruik de letterlijke tekenreeksen true of false in kleine letters. |
ERR_UNKNOWN_PARAMETERS |
Het verzoek bevat een of meer parameters die het eindpunt niet accepteert. | Vergelijk het verzoek met de lijst met parameters voor het eindpunt in de interactieve documentatie. Veelvoorkomende oorzaken zijn onder meer typefouten, parameters die voor een ander eindpunt zijn bedoeld, of extra trackingparameters die door een HTTP-client zijn toegevoegd. |
ERR_DUPLICATE_PARAMETERS |
Dezelfde parameter wordt meer dan eens doorgegeven en het eindpunt accepteert geen duplicaten voor die parameter. | Controleer de lijst met parameters. De parameter printerId mag herhaald worden (één keer per printer); andere parameters mogen maximaal één
keer voorkomen. |
ERR_EMPTY_PARAMETERS |
Er is een verplichte parameter aanwezig, maar deze heeft geen waarde. | Controleer of elke verplichte parameter een niet-lege waarde heeft. |
ERR_INVALID_TENANT_ID |
De tenant-ID die aan de API-sleutel is gekoppeld, is ongeldig. | Neem contact op met uw Ricoh-accountmanager. |
Fouten in de omvang van de respons en de onderzoeksmethode
| Foutcode | Waarschijnlijke oorzaak | Wat u kunt proberen |
|---|---|---|
ERR_RESPONSE_LIMIT_EXCEEDED (413) |
De gegevens die overeenkomen met de aanvraag, zouden de maximale responsgrootte overschrijden.
De responstekst bevat een veld maxJobs dat de geldende limiet aangeeft. |
Beperk de datumperiode, vraag minder printers aan, of doe beide, en dien de aanvraag opnieuw in. Zie Omgaan met responslimieten van de gegevensexport-API voor aanbevolen patronen voor het opdelen in blokken. |
ERR_UNSUPPORTED_METHOD (405) |
Bij het verzoek werd een andere HTTP-methode dan GET gebruikt. |
De gegevensexport-API ondersteunt uitsluitend de GET -methode. Werk uw client bij zodat deze GET gebruikt. |
Serverfouten (500 Interne serverfout)
500 reacties duiden op een onverwachte voorwaarde op de server. Herhalingspogingen
zijn veilig omdat elk eindpunt van de gegevensexport-API een GET-verzoek is en geen neveneffecten veroorzaakt. Wacht enkele seconden voordat u het
opnieuw probeert, en pas exponentiële backoff toe als de fout blijft optreden.
| Foutcode | Waarschijnlijke oorzaak | Wat u kunt proberen |
|---|---|---|
ERR_INTERNAL_SERVER_ERROR |
Er heeft zich een onverwachte voorwaarde op de server voorgedaan. | Wacht enkele seconden en probeer het opnieuw. Mocht de fout langer dan enkele minuten aanhouden, neem dan contact op met uw Ricoh-accountmanager. |
ERR_TENANT_CHECK_FAILED |
De server kon de tenant die aan de API-sleutel is gekoppeld, niet verifiëren. | Wacht enkele seconden en probeer het opnieuw. Mocht de fout blijven bestaan, neem dan contact op met uw RICOH-accountmanager. |
ERR_PRINTERS_FETCH_FAILED |
De server kon de lijst met printers voor de tenant niet ophalen. | Wacht enkele seconden en probeer het opnieuw. Mocht de fout blijven bestaan, neem dan contact op met uw RICOH-accountmanager. |
ERR_PRINTER_STATES_FETCH_FAILED |
De server kon de gegevens over de status van de printer voor het verzoek niet ophalen. | Wacht enkele seconden en probeer het opnieuw. Mocht de fout blijven bestaan, neem dan contact op met uw RICOH-accountmanager. |
Overige symptomen
- Het antwoord is leeg (
[]), maar u verwacht gegevens - Een lege array betekent dat er geen overeenkomende records zijn gevonden. Controleer
het tijdsbestek (de API geeft alleen gegevens van de afgelopen zeven dagen weer),
de tijdzone, de
printerId-waarden en eventuele filters, zoalsJobStateofstateCategory. - De datum- en tijdwaarden in het antwoord zijn niet-overeenkomend met wat u had verwacht
- De tijdstempels van de reacties zijn lokale tijden in de tijdzone die bij het verzoek
is opgegeven. Wanneer u hetzelfde verzoek indient met een andere
tijdzonewaarde, worden er verschillende tijdstempelstekenreeksen gegenereerd, ook al hebben deze betrekking op dezelfde gebeurtenissen. Zie Verwerking van datum en tijd in de gegevensexport-API. - Er ontbreekt een printer in het antwoord van
/printers - De API geeft uitsluitend printers weer die door een data collector worden gemonitord. Indien een printer ontbreekt, controleer dan of deze bij een data collector is geregistreerd en momenteel heeft hij een verbinding.
- Een reactie van de printerstatus bevat
unknowncategorieën - Een
unknowncategorie geeft aan dat de ruwe status van de printer niet kon worden ingedeeld. Zie Printertoestanden en toestandscategorieën voor het volledige overzicht van de koppeling tussen staten en categorieën.