错误与限流
所有公开接口统一返回 object / list / error 三类响应,并通过请求头传递 request id 与限流信息。
响应模型
单资源直接返回对象,例如 monitoring.job。
列表返回 { object: "list", data: [...] }。
错误返回 { error: { code, message, request_id, details? } }。
1{2"error": {3"code": "INVALID_ARGUMENT",4"message": "请求参数无效",5"request_id": "req_01ht2error",6"details": {7"fieldErrors": {8"subreddit": [9"Required"10]11}12}13}14}
响应头
每次请求的唯一 ID,用于排障和日志关联。
当前 Token 的限流窗口总额度。
当前窗口剩余额度。
当前窗口重置时间(Unix timestamp 秒)。
被限流时,建议等待的秒数。
常见错误码
- UNAUTHORIZED:缺少或无效 Token。
- FORBIDDEN:Token 存在,但 scope 不够。
- INVALID_ARGUMENT:请求体、query 或 path 参数不合法。
- NOT_FOUND:资源不存在或不属于当前账户。
- RATE_LIMITED:当前 Token 调用过于频繁。
- RESULT_NOT_READY:异步任务还没产出结果。
机器可读的错误码。
面向调用方的错误描述。
本次请求的 request id。
参数校验失败等场景下的补充细节。