10 KiB
错误与恢复说明
只查当前错误对应章节。先读取结构化字段,再决定修正、重试、请求用户介入或停止。
错误返回格式
{
"error": {
"code": 3,
"category": "validation",
"message": "missing required flag(s): --base-id",
"reason": "...",
"retryable": false,
"hint": "...",
"actions": ["..."]
}
}
错误写到 stderr。code 是 CLI 退出码,category 是稳定大类:api、auth、
validation、discovery、internal。其他字段按错误类型出现,不保证每次都有。
错误分类与 Agent 行为
可自行修复
category=validation且available_flags/hint给出明确修正:核对 leaf Help,修正 一次;不要猜 flag。- 自然目标返回
details.candidates:零命中或多候选都停止并消歧,禁止选择第一项。 reason=confirmation_required:完整协议见 confirmation.md (展示摘要 → 用户显式同意 → 原始命令追加--yes;禁止静默重试、管道喂答案、换成更弱命令)。
需用户介入
- 权限不足、资源不存在、配额/权益不足:报告
server_error_code、trace_id、hint和action_url(如有),不自行改身份或尝试替代接口。 - profile 不存在或同组织多账号无默认:让用户指定
corpId:userId,不要选最近账号。 - 未知投递状态:停止重发,先查询状态;没有状态查询能力时如实报告未知。
重试规则
retryable=true:遵守retry_after_seconds或next_retry_at;运行时可能已经完成 HTTP 重试,调用方只做一次有界重试并保留相同幂等键。retryable=false:不要重试。- 未出现
retryable:不要从category、HTTP 文案或“看起来像临时错误”推断可重试; 使用--verbose收集诊断后停止。 - 超时不会因为盲目增大
--timeout自动变安全。只有任务确实允许更长等待且操作状态可判定时, 才显式调整超时。
认证与权限
- 精确的 access-token 拒绝信号会由 Runtime 自动刷新并最多重放一次;不要再包一层“重试两次”。
reason=auth_refresh_failed或auth status返回authenticated=false:保留原错误,运行dws auth status --profile <same-profile> --format json;按返回hint恢复,必要时请用户登录。- HTTP/RPC 403 与普通权限不足不会触发 token 刷新;不要通过切 profile、bot 或 webhook 身份绕过。
- AppKey/AppSecret 缺失只用于应用凭据配置问题;不要向普通业务用户索要凭据。
aitable 高频错误
参数体系:
baseId / tableId / fieldId / recordId。CLI flag 用 kebab-case(--base-id),JSON 内用 camelCase(baseId)。
- 参数缺失 / 无效请求 — 还在用旧参数
dentryUuid/--doc/--sheet→ 改用--base-id/--table-id/--field-id/--record-ids - 参数传了但服务端没收到 — flag 用了 camelCase(如
--baseId)→ flag 用 kebab-case:--base-id <ID> record query --filters无结果 — 单选/多选过滤用了 option name 而非 id → 先field get读取 options,用 option id 过滤- record create/update 失败 —
cellskey 用了字段名(应为 fieldId);特殊字段格式错误 → 先field get拿字段目录;url 传{"text":"..","link":".."} - 更新选项后历史数据异常 — 更新 options 没传完整列表 / 没保留原 id → 先
field get取完整配置,保留已有 option 的 id cannot delete the last table— 该表是 Base 最后一张表 → 先新建表再删旧表,或用base deleteformula类型not supported yet— 部分字段类型暂不支持 API 创建 → 复杂字段拆开单独创建,先建基础结构
排查链路: base list → base get(→tableId) → field get(→fieldId) → record query(→recordId)。别跳步,别猜 ID。
批量上限: record 100 条 / field 15 个 / table·field 详情 10 个。
doc 高频错误
- 文档不存在 / nodeId 无效 — nodeId 或 URL 不正确、文档已删除 →
drive search/wiki node search或wiki node list重新获取正确 nodeId - 无下载权限 — 文档分享设置不允许 → 报告用户,建议联系文档所有者
update --mode overwrite意外清空 — overwrite 会清空原内容后重写 → 默认用--mode append,overwrite 前必须跟用户确认- 块编辑 blockId 无效 — blockId 过期或文档结构已变 → 先
block list刷新获取最新 blockId doc_write_commit_unknown— 某个分片写入超时,服务端是否已提交无法判断 → 不会自动重试(重放会重复追加)。details给出chunksWritten/chunksTotal/failedStage;先用doc read --node <ID>回读确认实际写到哪一片,只有确认未提交才重新执行,再从断点处用doc update --mode append继续追加
calendar 高频错误
- 误用顶层
dws calendar/ 臆造calendar list— 只输入dws calendar或尝试不存在的calendar list会打印大段 Usage,易导致上下文暴涨与响应变慢 → 改用dws calendar event list --start "<ISO>" --end "<ISO>" --format json,或加载dingtalk-calendar后按其日程查询 recipe 执行;详见dingtalk-calendar「CLI 命令树与黄金路径」「反模式(禁止)」 - 时间格式错误 — 未使用 ISO-8601 格式 → 标准格式:
2026-03-10T14:00:00+08:00 - 会议室搜索报错 / 返空 — 企业会议室超 100 条未分组查询 → 先
room list-groups→ 按--group-id逐组搜索 - 参与者 / 会议室添加失败 — eventId 不正确 → 先
event list或event create获取正确 eventId roomId invalid/ 订房失败 — 把会议室展示名或用户口语当成了roomId→ 只能使用room search返回 JSON 中的rooms[].roomId填入room add --rooms;不得以中文名、楼层编号文案充当 IDunknown flag: --query(会议室)—room search不支持按名称搜索 → 先room list-groups再按分组room search,在返回列表中匹配名称后取roomId(见 calendar.md)
chat 高频错误
- 群聊读取优先
chat +chat-messages --group <群名或ID>;单聊先解析唯一用户 ID 再读取。 自然群名多候选时读取details.candidates并让用户消歧,不取第一项。 - 普通发送优先
chat +dm、chat +send-to-group或chat +messages-send;发送类 Shortcut 的最终 Schema 要求确认时,必须先确认再加--yes。 --group、--user、--open-dingtalk-id等目标参数互斥:按 leaf Help 只传一类目标。+messages-send的--text/--markdown/--media-id/--file互斥;身份、目标、 凭据和幂等参数还受 user/bot/webhook 能力矩阵约束。ok=false、partial=true、非空failures或分页仍有 continuation 都不是完整成功; 必须保留 ledger,不能只返回已成功部分。- 机器人不在群或当前用户无管理权限:报告真实失败,需要群管理员处理;不改用当前用户身份发送。
- 原子
chat message send只用于 Shortcut 未覆盖的底层消息类型/原始字段。其正文可用--text,不要把某个历史位置参数写法当成所有发送入口的规则。
oa 高频错误
- approve/reject 缺少 taskId — 未先获取审批任务 → 先
approval tasks --instance-id <ID>获取 taskId - list-initiated 缺少 processCode — 未查询审批表单 → 先
approval list-forms或detail获取 processCode - 撤销审批失败 — 非本人发起的审批 →
revoke只能撤销自己发起的审批
report 高频错误
参数体系:
templateId / reportId。CLI flag 用 kebab-case(--template-id/--contents-file)。contents数组每项含key/sort/content/contentType/type五个字段,key/sort/type必须严格对齐template get返回的field_name/field_sort/field_type。
INPUT_INVALID_JSON—--contents或--contents-file内容非合法 JSON → 检查数组结构[{key, sort, content, contentType, type}]INPUT_FILE_NOT_FOUND—--contents-file路径错 / sandbox OS 风格不匹配 → 先确认 sandbox OS(Windows:C:\.../ macOS|Linux:/...)后改写INPUT_MISSING_PARAM—--template-id或 contents 必填缺失 → 先跑dws report template list --format json取 templateIdMCP_TOOL_ERROR+server_error_code: PARAM_ERROR— 服务端业务校验失败(templateId 错 /key不在模版定义 / 类型不匹配 / 必填空 等多种形态都返回这一个码,且服务端不区分子原因)→ 不要靠错误信息排查具体字段,按提交链路重新走template list → template get → entry submit;连续 ≥ 2 次失败必须停止重试,降级 final_replyMCP_TOOL_ERROR+ 其他 server_error_code — 查看technical_detail;如出现不可读错误(仅含root.success当前值),降级 final_reply 引导用户手动操作
排查链路:template list → template get(取 result.report_template_fields[],每项含 field_name/field_sort/field_type)→ 拼 --contents:field_name → key、field_sort → sort、field_type → type,再填 content 与 contentType → entry submit。别跳步、别猜字段名、别自己改写 key 名。
contact / drive / mail 高频错误
- contact:
dept list-children报错 —--id传了非整数值 → deptId 必须为整数,从dept search获取 - drive: 文件不存在 — dentryUuid 不正确 →
drive list逐级浏览获取正确 ID - drive: 上传失败 / uploadId 无效 — 跳过了
upload-info步骤 → 必须先upload-info获取上传凭证,再commit - drive: 文件名报错 —
--file-name缺少扩展名 → 必须包含扩展名:report.pdf - mail: 发件地址不正确 — 未先查询可用邮箱 → 先
mailbox list获取邮箱地址 - mail: KQL 搜索无结果 — 查询语法错误 → 字段值含空格用双引号:
subject:\"周报\"
通用排查三步法
- 确认 ID — 从最顶层资源逐级获取,不猜 ID、不跳步
- 确认参数 — flag 用 kebab-case,JSON 用 camelCase;特殊字段查产品参考文档确认格式
- 确认限制 — 检查批量上限和已知约束(各产品注意事项见对应产品参考文档)