自动化

列出运行调用

分页读取调用账本及执行结果。

分页读取调用账本及执行结果。结果按账本顺序列出目标、参数与结果预览、状态和耗时。脚本运行读调用账本;工作流运行的动作调用记在步骤上,这里列出带动作的步骤(不含被跳过的),与 counters.action_calls 一致。

GET /automation/v1/runs/{id}/calls

鉴权

Authorization: Bearer $PRAXIS_API_KEY

请求字段

参数类型说明
path: idstring必填;运行 ID(run_)。
query: limitinteger可选;运行台账每页条数,整数 1–200,默认 50;其它集合上限为 100。 minimum: 1;maximum: 200
query: cursorstring可选;上一页返回的 next_cursor,不透明字符串;保持原查询条件继续翻页。

示例

先设置以下环境变量,使用你自己的资源:

: "${RUN_ID:?Set RUN_ID}"
curl --fail-with-body -X GET "https://api.deepraxis.ai/automation/v1/runs/${RUN_ID}/calls" \
  -H "Authorization: Bearer $PRAXIS_API_KEY"
import { createAutomationClient } from '@deepractice-ai/praxis-sdk/automation';

function env(name: string): string {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
}
const automation = createAutomationClient({
  apiKey: env('PRAXIS_API_KEY'),
  baseUrl: 'https://api.deepraxis.ai',
  maxRetries: 0,
  timeoutMs: 90_000,
});
const result = await automation.runs.calls.list({
  "path": {
    "id": env("RUN_ID")
  }
});
console.log(result);

响应

HTTP 200

Success

application/json

字段类型说明
dataobject[]必填 / 必有;本页的脚本调用记录,按 seq 顺序排列。
data[].idstring必填 / 必有;调用 ID,前缀 call_。
data[].run_idstring必填 / 必有;发出该调用的脚本运行 ID(run_ 前缀)。
data[].seqnumber必填 / 必有;调用在该运行中的序号,随调用顺序递增;与 run_id 一起定位这次调用。
data[].targetobject必填 / 必有;被调用的目标 {kind, name, revision?, version?}。 不接受额外字段。
data[].target.kind"action" / "script" / "workflow" / "platform_api"必填 / 必有;目标类型。action 为动作;platform_api 为平台 API 操作;script 为脚本;workflow 为工作流。
data[].target.namestring必填 / 必有;目标名称:动作为 ns/name,平台 API 为操作名,脚本与工作流为 ns/name。
data[].target.revisionstring可选;实际执行的动作修订 ID(actr_ 前缀);仅动作调用有。
data[].target.versionstring可选;实际运行的精确版本号;仅脚本与工作流调用有。
data[].args_previewstring必填 / 必有;调用参数的单行预览,由服务端截断;超过 32 KB 的原文存放在对象存储而不内联。
data[].result_previewnull / string必填 / 必有;返回值的单行预览,由服务端截断;调用结束前为 null。
data[].status"running" / "completed" / "faulted" / "cancelled"必填 / 必有;调用状态。running 执行中;completed 已正常返回;faulted 失败,error 给出原因;cancelled 因运行被取消而中止。
data[].started_atstring必填 / 必有;调用开始的时间(RFC 3339 UTC)。
data[].ended_atnull / string必填 / 必有;调用结束的时间(RFC 3339 UTC);仍在执行为 null。
data[].duration_msnull / number必填 / 必有;从开始到结束的毫秒数;未结束为 null。
data[].errornull / object必填 / 必有;调用失败时的错误详情;成功或仍在执行为 null。
data[].error(分支2).typestring必填 / 必有;平台错误类别,或工作流 raise 定义的完整 URI,原样保留。
data[].error(分支2).codenull / string必填 / 必有;稳定错误码,可按码分支处理;没有为 null。
data[].error(分支2).titlestring必填 / 必有;错误的简短标题。
data[].error(分支2).detailnull / string必填 / 必有;错误的详细说明;没有为 null。
data[].error(分支2).sourcenull / object必填 / 必有;错误发生的位置:工作流步骤或脚本调用;未知为 null。
data[].error(分支2).source(分支2).kind"call" / "task"必填 / 必有;位置类型。task 表示工作流步骤;call 表示脚本中的调用。
data[].error(分支2).source(分支2).referencestring可选;task 类型时:出错步骤的 JSON Pointer。
data[].error(分支2).source(分支2).seqnumber可选;call 类型时:出错调用的序号(与 Call.seq 对应)。
data[].error(分支2).source(分支2).actionobject可选;出错的动作 {name, revision};错误来自动作时才有。 不接受额外字段。
data[].error(分支2).source(分支2).action.namestring必填 / 必有;动作全名 ns/name。
data[].error(分支2).source(分支2).action.revisionstring必填 / 必有;执行的动作修订 ID(actr_ 前缀)。
data[].error(分支2).request_idstring / null可选;导致失败的下游响应 X-Request-Id;没有下游响应标识时为 null 或省略。
data[].error(分支2).errorsobject[]可选;逐字段校验错误;pointer 使用 RFC 6901 指向字段,detail 为中文修正说明。
data[].error(分支2).errors[].pointerstring必填 / 必有;RFC 6901 字段指针。TypeScript 源码诊断为 /source(脚本)或 /implementation/source(动作);行列另见 line/column,不拼在指针后。
data[].error(分支2).errors[].detailstring必填 / 必有;中文修正说明,指出该位置出了什么问题以及怎样改。
data[].error(分支2).errors[].hintstring可选;可选的补充提示,给出下一步可执行的动作(例如改用另一个接口)。
data[].error(分支2).errors[].lineinteger可选;行号,从 1 起;仅有源码位置时返回。 minimum: 1
data[].error(分支2).errors[].columninteger可选;列号,从 1 起;仅有源码位置时返回。 minimum: 1
data[].error(分支2).statusnumber可选;工作流 raise 声明的 HTTP 风格状态;可省略,平台错误可能不提供。
data[].child_run_idnull / string必填 / 必有;目标是脚本或工作流时,由本次调用启动的子运行 ID;动作与平台 API 调用为 null。
data[].invocation_keystring必填 / 必有;标识这一次逻辑调用的键,随调用发往下游,使至少一次语义下的重试可被去重。
data[].request_idstring / null必填 / 必有;下游响应的 X-Request-Id;尚未收到响应或响应未提供该头时为 null。
next_cursornull / string必填 / 必有;下一页游标,原样传给 cursor 参数并保持原查询条件;没有更多页为 null。接口不返回总数。

实测响应

HTTP 200

{
  "data": [],
  "next_cursor": null
}

错误码

HTTP错误码与说明
400INVALID_PARAMS:请求参数、路径、游标或请求体格式无效。
404RUN_NOT_FOUND:运行不存在或当前租户不可见。
defaultRFC 9457 automation problem. 429 includes Retry-After.

鉴权错误与通用错误 · 排查时保留响应头 X-Request-Id。

导出

本页内容