/v1 错误响应均为 application/problem+json(RFC 9457),并包含一组固定字段:
code 进行分支处理,切勿依据 detail——code 是稳定的机器契约,而 detail 供人工阅读,可能会发生变化。当错误可归因于某个特定的请求参数时,会包含 param。联系支持团队时,请提供 request_id。
错误代码
错误代码集是封闭的:新增代码属于公共契约变更,并将通过 API 变更日志发布公告。
retryable: true 响应表示相关状况可能会自行恢复,但并不能证明写入操作没有产生任何影响。重试读取操作时,请设定有限的尝试次数和时间预算,并采用指数退避和抖动。如果存在 Retry-After,请予以遵循,包括在可重试的 409 或 429 响应中。
对于变更操作,请遵循该操作已记录的幂等性和恢复契约。在受支持的情况下,请保留原始密钥和原始请求。超时或出现 5xx 后,请勿另行生成新的密钥:这样做可能会导致已成功的写入被重复执行。对于不支持幂等性的操作,Idempotency-Key 标头不能提供任何保护。
