错误码对照表
本文描述 API 的公共错误返回,与对应的解决方法。公共错误与具体业务接口无关,一般为公共参数的缺失,项目状态异常,签名失败,或业务流控触发等场景返回。
公共错误的返回格式
错误触发后,Response Body 会输出错误的详细信息,内容为JSON
格式的字符串,包括字段:
error
:错误的唯一代码,可以作为错误的识别标识,公共错误统一以 "oray_paas/" 作为前缀msg
:详细的错误信息,供开发人员阅读的自然语言信息
例:
{
"error": "oray_paas/missing_app_key",
"msg": "missing required HTTP header parameter [X-OPA-APP-KEY]"
}
公共错误对照表
错误代码 | HTTP Status code | 说明 |
---|---|---|
oray_paas/missing_app_key | 400 | 缺少 AppKey 参数,详见平台签名校验 |
oray_paas/app_status_exception | 403 | 应用项目状态异常,请检查以下内容 1. AppKey 参数是否传入错误 2. 相关服务配额是否已耗尽 3. 项目合约或授权是否已过期 |
oray_paas/invalid_request_signature | 403 | 签名校验失败,无效的签名,详见平台签名校验,检查请求参数 |
oray_paas/limit_exceeded | 429 | 请求频率超过应用服务限制,配合 Retry-After 响应头处理重试 |
oray_paas/app_service_forbidden | 403 | 当前应用(AppKey)没有该服务接口的访问权限,请到管理平台检查您的项目授权 |
oray_paas/duplicate_nonce | 403 | 重复的随机串,详见平台签名校验 |
oray_paas/service_deplicated | 404 | 指定的 API(版本)已弃用,参见相关产品文档以、公告或服务通知 |
业务错误
见具体的API接口文档
最后修改时间: 6 天前
**公共错误的返回格式**
**公共错误对照表**
**业务错误**