ComPDF AI 开放 API 错误码说明

适用范围

本文仅适用于公开 Open API 请求。

错误响应

Open API 错误响应包含 HTTP 状态码、数值 code、稳定的 error_code、message 和可选的 data：

{
  "code": 102,
  "error_code": "INVALID_RULE_CONFIGURATION",
  "message": "提醒规则配置不合法",
  "data": false
}

请使用 error_code 判断错误类型，不应解析用于展示的 message。

开放 API 错误码

error_code	Code	HTTP 状态码	说明
INTERNAL_ERROR	100	500	服务端发生未预期的错误。
INVALID_ARGUMENT	101	400	请求参数缺失、不合法或格式不受支持。
INVALID_RULE_STATUS	102	400	提醒规则状态不是允许值。
INVALID_RULE_CONFIGURATION	102	400	提醒规则的条件、频率、投递渠道或收件人配置不合法。
API_KEY_REQUIRED	401	401	请求未提供 Service API Key。
API_KEY_INVALID	401	401	Service API Key 无效、已停用或已过期。
RULE_NOT_FOUND	404	404	提醒规则不存在，或不属于当前 API Key 对应组织。
RESOURCE_CONFLICT	409	409	当前资源状态不允许执行该操作。

提醒规则 API 错误映射

Open API	可能的 error_code
POST /api/v2/rules	API_KEY_REQUIRED、API_KEY_INVALID、INVALID_RULE_CONFIGURATION、RESOURCE_CONFLICT、INTERNAL_ERROR
GET /api/v2/rules	API_KEY_REQUIRED、API_KEY_INVALID、INVALID_ARGUMENT、INVALID_RULE_STATUS、INTERNAL_ERROR
GET /api/v2/rules/{ruleId}	API_KEY_REQUIRED、API_KEY_INVALID、RULE_NOT_FOUND、INTERNAL_ERROR
PUT /api/v2/rules/{ruleId}	API_KEY_REQUIRED、API_KEY_INVALID、INVALID_RULE_CONFIGURATION、RULE_NOT_FOUND、RESOURCE_CONFLICT、INTERNAL_ERROR
PATCH /api/v2/rules/{ruleId}/status	API_KEY_REQUIRED、API_KEY_INVALID、INVALID_RULE_STATUS、RULE_NOT_FOUND、INTERNAL_ERROR
DELETE /api/v2/rules/{ruleId}	API_KEY_REQUIRED、API_KEY_INVALID、RULE_NOT_FOUND、INTERNAL_ERROR