适用版本 | 中心版、Region版 |
服务接入点与授权信息
产品 | 资源 | 所需权限 |
组织管理 | 自动化定时任务 | 只读 |
请求语法
中心版
GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/automation/scheduled-tasks/{name}/runsRegion版
GET https://{domain}/oapi/v1/platform/automation/scheduled-tasks/{name}/runs请求头
参数 | 类型 | 是否必填 | 描述 | 示例值 |
x-yunxiao-token | string | 是 | 个人访问令牌。 | pt-0fh3****0fbG_35af****0484 |
请求参数
参数 | 类型 | 位置 | 是否必填 | 描述 | 示例值 |
organizationId | string | path |
| 组织 ID。 | |
name | string | path | 是 | 任务名称。 | |
limit | integer | query | 否 | 返回的运行数量上限,默认 20,最大 50。 | |
eventId | string | query | 否 | 仅返回指定触发事件的运行(手动触发接口返回的 eventId)。 |
请求示例
中心版
curl -X 'GET' \
'https://{domain}/oapi/v1/platform/organizations/{organizationId}/automation/scheduled-tasks/{name}/runs?limit={limit}&eventId={eventId}' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'Region版
curl -X 'GET' \
'https://{domain}/oapi/v1/platform/automation/scheduled-tasks/{name}/runs?limit={limit}&eventId={eventId}' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'返回参数
参数 | 类型 | 描述 | 示例值 |
| - | object | ||
| runs | array | 按触发事件聚合的运行记录,新到旧排列。 | |
| - | object | ||
eventId | string | 触发事件 ID;手动触发形如 manual:{ruleId}:{yyyyMMddHHmm}。 | |
finishedAt | string | 运行结束时间;未结束或历史数据缺失时省略。 | |
ruleVersion | integer | 本次运行对应的规则版本。 | |
startedAt | string | 运行开始时间。 | |
status | string | 整次运行的聚合状态,可能的值:[running success partial failed skipped]。 | running |
| steps | array | 按规则节点顺序排列的分步执行明细。 | |
| - | object | ||
actionId | string | 规则节点 ID。 | run_ai |
detail | string | 执行详情(已脱敏)。 | |
durationMs | integer | 执行耗时(毫秒)。 | |
finishedAt | string | 节点结束时间;未结束时省略。 | |
kind | string | 节点类型,可能的值:[ai mail dingtalk unknown]。 | ai |
startedAt | string | 节点开始时间。 | |
status | string | 节点执行状态,可能的值:[running success failed skipped]。 | running |
trigger | string | 触发来源,可能的值:[manual schedule]。 | manual |
truncated | boolean | 更早的运行记录存在但未返回(超出聚合窗口或 limit)。 |
返回示例
{
"runs": [
{
"eventId": "",
"finishedAt": "",
"ruleVersion": 0,
"startedAt": "",
"status": "running",
"steps": [
{
"actionId": "run_ai",
"detail": "",
"durationMs": 0,
"finishedAt": "",
"kind": "ai",
"startedAt": "",
"status": "running"
}
],
"trigger": "manual"
}
],
"truncated": false
}错误码
访问错误码中心查看 API 相关错误码。