外观
文档错误码(185*)
段位:185001 - 185999;当前 17 个;全部 V1 暴露
通用约定(HTTP status /
code=1兜底 / 响应结构)见 README经 V1
/v1/documents/*(创建 / 更新 / 归档 / 发布 / 回收站 / 恢复 等)与/v1/versions/*(版本读取 / 回退)暴露的文档生命周期校验。部分相邻语义复用其它段位的码:「目标文档 / 容器不存在」见 元数据错误码 182008 / 182009;「文档状态非 ACTIVE 不可上传新版本」见 文件错误码 179024。
185001 DOCUMENT_ROOT_TYPE_NOT_INITIALIZED
- HTTP status:200
- 含义:租户文档根类型未初始化
- 典型触发条件:创建文档时租户尚未初始化文档根类型
- 处理建议:由管理员在 Console 完成租户内容模型初始化后重试
- 示例响应:
json
{ "code": 185001, "msg": "文档根类型未初始化", "data": null }185002 DOCUMENT_TYPE_DEPRECATED
- HTTP status:200
- 含义:文档类型已弃用
- 典型触发条件:以一个处于 DEPRECATED 状态的内容类型创建新文档
- 处理建议:改用未弃用的文档类型;已有文档不受影响
- 示例响应:
json
{ "code": 185002, "msg": "文档类型已弃用,不允许创建新文档", "data": null }185003 DOCUMENT_TYPE_DISABLED
- HTTP status:200
- 含义:文档类型已禁用
- 典型触发条件:以一个处于 DISABLED 状态的内容类型创建新文档
- 处理建议:改用 ACTIVE 状态的文档类型
- 示例响应:
json
{ "code": 185003, "msg": "文档类型已禁用,不允许创建新文档", "data": null }185004 DOCUMENT_TYPE_NOT_ACTIVE
- HTTP status:200
- 含义:更新指定的文档类型非 ACTIVE
- 典型触发条件:更新文档时把类型切换到一个未启用的内容类型
- 处理建议:仅切换到 ACTIVE 状态的文档类型
- 示例响应:
json
{ "code": 185004, "msg": "文档类型未启用", "data": null }185005 DOCUMENT_STATE_UPDATE_NOT_ALLOWED
- HTTP status:200
- 含义:不允许通过更新接口修改文档状态
- 典型触发条件:在
update请求里试图直接改写文档状态 - 处理建议:状态变更走专用端点——归档
/archive、删除/trash、恢复/trash/restore、发布/publish等 - 示例响应:
json
{ "code": 185005, "msg": "不允许通过更新接口修改文档状态", "data": null }185006 DOCUMENT_NOT_ACTIVE_FOR_ARCHIVE
- HTTP status:200
- 含义:仅 ACTIVE 状态的文档可归档
- 典型触发条件:对非 ACTIVE 文档调用归档
- 处理建议:先确认文档处于 ACTIVE 再归档
- 示例响应:
json
{ "code": 185006, "msg": "仅 ACTIVE 文档可归档", "data": null }185007 DOCUMENT_NOT_ARCHIVED_FOR_UNARCHIVE
- HTTP status:200
- 含义:仅 ARCHIVED 状态的文档可取消归档
- 典型触发条件:对非归档状态文档调用取消归档
- 处理建议:仅对处于 ARCHIVED 的文档取消归档
- 示例响应:
json
{ "code": 185007, "msg": "仅 ARCHIVED 文档可取消归档", "data": null }185008 DOCUMENT_ALREADY_TRASHED
- HTTP status:200
- 含义:文档已在回收站中
- 典型触发条件:对已在回收站的文档重复执行删除(移入回收站)
- 处理建议:无需重复删除;如需彻底清除走
/trash/purge,如需找回走/trash/restore - 示例响应:
json
{ "code": 185008, "msg": "文档已在回收站中", "data": null }185009 DOCUMENT_NOT_TRASHED
- HTTP status:200
- 含义:文档不在回收站中,无法恢复
- 典型触发条件:对未在回收站的文档调用恢复
- 处理建议:仅对处于回收站的文档执行恢复
- 示例响应:
json
{ "code": 185009, "msg": "文档不在回收站中", "data": null }185010 DOCUMENT_RESTORE_CONTAINER_DELETED
- HTTP status:200
- 含义:恢复失败——原容器已删除
- 典型触发条件:恢复回收站文档时,其原所属容器已被删除
- 处理建议:先恢复 / 重建目标容器,或将文档恢复到其它有效容器
- 示例响应:
json
{ "code": 185010, "msg": "恢复失败:原容器已删除", "data": null }185011 DOCUMENT_RESTORE_CONTAINER_NOT_ACTIVE
- HTTP status:200
- 含义:恢复失败——所属容器状态非 ACTIVE
- 典型触发条件:恢复回收站文档时,其所属容器处于归档 / 回收站等非 ACTIVE 状态
- 处理建议:先把目标容器恢复到 ACTIVE 再恢复文档
- 示例响应:
json
{ "code": 185011, "msg": "恢复失败:所属容器非 ACTIVE", "data": null }185012 DOCUMENT_PURGE_NOT_TRASHED
- HTTP status:200
- 含义:仅回收站中的文档可彻底清除
- 典型触发条件:对未在回收站的文档调用彻底清除
- 处理建议:彻底清除前需先将文档移入回收站
- 示例响应:
json
{ "code": 185012, "msg": "仅回收站中的文档可彻底清除", "data": null }185013 DOCUMENT_NOT_ACTIVE_FOR_PUBLISH
- HTTP status:200
- 含义:仅 ACTIVE 状态的文档可发布
- 典型触发条件:对非 ACTIVE 文档调用发布
- 处理建议:先确认文档处于 ACTIVE 再发布
- 示例响应:
json
{ "code": 185013, "msg": "仅 ACTIVE 文档可发布", "data": null }185014 DOCUMENT_VERSION_NOT_FOUND_OR_MISMATCH
- HTTP status:200
- 含义:版本不存在或不属于该文档
- 典型触发条件:发布 / 回退时指定的目标版本不存在,或不属于该文档
- 处理建议:核对
versionId是否属于目标文档;可先查该文档的版本列表 - 示例响应:
json
{ "code": 185014, "msg": "版本不存在或不属于该文档", "data": null }185015 DOCUMENT_NOT_ACTIVE_FOR_UNPUBLISH
- HTTP status:200
- 含义:仅 ACTIVE 状态的文档可取消发布
- 典型触发条件:对非 ACTIVE 文档调用取消发布
- 处理建议:先确认文档处于 ACTIVE 再取消发布
- 示例响应:
json
{ "code": 185015, "msg": "仅 ACTIVE 文档可取消发布", "data": null }185016 VERSION_NOT_FOUND
- HTTP status:200
- 含义:版本不存在
- 典型触发条件:按
versionId解析版本失败(如读取 / 下载指定版本) - 处理建议:核对
versionId;可先查该文档的版本列表确认其存在 - 示例响应:
json
{ "code": 185016, "msg": "版本不存在", "data": null }185017 DOCUMENT_NOT_ACTIVE_FOR_REVERT
- HTTP status:200
- 含义:仅 ACTIVE 状态的文档可执行版本回退
- 典型触发条件:对非 ACTIVE 文档调用版本回退
- 处理建议:先确认文档处于 ACTIVE 再回退
- 示例响应:
json
{ "code": 185017, "msg": "仅 ACTIVE 文档可执行版本回退", "data": null }