/v1-virhevastaus on muodossa application/problem+json (RFC 9457), ja sen kentät ovat kiinteät:
code, älä koskaan kenttää detail — code on vakaa konesopimus, kun taas detail on ihmisluettava ja voi muuttua. param on mukana, kun virhe johtuu tietystä pyynnön parametrista. Liitä request_id mukaan, kun otat yhteyttä tukeen.
Virhekoodit
Koodijoukko on suljettu: uudet koodit ovat julkisen sopimuksen muutos, ja niistä ilmoitetaan rajapinnan muutosloki.
retryable: true-vastaus tarkoittaa, että tilanne voi ratketa; se ei todista, ettei kirjoitusoperaatiolla ollut vaikutusta. Yritä lukuoperaatioita uudelleen rajallisella yritys- ja aikabudjetilla käyttäen eksponentiaalista viivettä (backoff) ja satunnaisviivettä (jitter). Noudata Retry-After-arvoa, kun se on annettu, myös uudelleenyritettävän 409- tai 429-vastauksen yhteydessä.
Muutosoperaatioissa noudata operaation dokumentoitua idempotenssi- ja palautumissopimusta. Säilytä alkuperäinen avain ja pyyntö, kun se on tuettu. Älä luo uutta avainta aikakatkaisun tai 5xx-virheen jälkeen: se voi toistaa onnistuneen kirjoituksen. Idempotency-Key-otsake ei anna suojaa operaatiossa, joka ei tue sitä.