开放平台API状态码说明文档
文档说明
本文档定义了开放平台API接口返回的状态码规范，用于明确接口调用结果、错误类型及原因，便于开发者快速定位和解决问题。所有API接口均遵循此状态码规则返回结果。
状态码分类规则
| 状态码段 | 分类说明 |
|---|---|
| 200 | 成功（接口调用正常完成） |
| 1xxxx | 通用错误（非分类性异常） |
| 2xxxx | 认证授权相关错误 |
| 4xxxx | 请求/参数校验相关错误 |
| 5xxxx | 接口相关错误 |
| 6xxxx | 限流相关错误 |
| 7xxxx | 业务逻辑相关错误 |
状态码详情
1. 成功状态码
| 状态码 | 枚举标识 | 说明 |
|---|---|---|
| 200 | SUCCESS | 接口调用成功 |
2. 通用错误（1xxxx）
| 状态码 | 枚举标识 | 说明 |
|---|---|---|
| 10000 | UNKNOWN_ERROR | 未知错误，请联系技术支持 |
3. 认证授权相关错误（2xxxx）
| 状态码 | 枚举标识 | 说明 |
|---|---|---|
| 20001 | API_KEY_MISSING | API密钥缺失（请求中未携带API Key参数） |
| 20002 | API_KEY_INVALID | 无效的API密钥（已禁用、过期或未审核通过） |
| 20010 | TIMESTAMP_MISSING | 时间戳参数缺失（请求中未携带timestamp参数） |
| 20011 | TIMESTAMP_FORMAT_ERROR | 时间戳格式错误（必须为10位或13位数字） |
| 20012 | TIMESTAMP_EXPIRED | 时间戳已过期（请求超时，需重新生成时间戳调用） |
| 20020 | SIGNATURE_MISSING | 签名参数缺失（请求中未携带signature参数） |
| 20021 | SIGNATURE_VERIFY_FAILED | 签名验证失败（签名生成规则错误或参数被篡改） |
4. 请求/参数校验相关错误（4xxxx）
| 状态码 | 枚举标识 | 说明 |
|---|---|---|
| 400 | INVALID_REQUEST | 请求体无法解析（需要检查请求参数的传递方式是否符合文档要求） |
| 404 | NOT_FOUND | 接口路径不存在（需要检查请求的路径是否正确） |
| 405 | REQUEST_METHOD_NOT_ALLOWED | 请求方法不允许（需要检查请求的方法是否符合文档要求） |
| 40001 | REQUIRED_PARAMS_EMPTY | 必填参数缺失（接口要求的必传参数未提交） |
| 40002 | REQUIRED_PARAMS_ILLEGAL | 请求参数不合法（参数格式/取值范围不符合要求） |
5. 接口相关错误（5xxxx）
| 状态码 | 枚举标识 | 说明 |
|---|---|---|
| 50001 | INTERFACE_NOT_FOUND | API接口不存在（请求路径错误） |
6. 限流相关错误（6xxxx）
| 状态码 | 枚举标识 | 说明 |
|---|---|---|
| 60001 | INTERFACE_RATE_LIMIT | 接口调用频率超限，请稍后重试 |
7. 业务逻辑相关错误（7xxxx）
| 状态码 | 枚举标识 | 说明 |
|---|---|---|
| 70001 | NOT_ENOUGH_CREDIT | 账户余额不足，请充值 |