接口调用
适用版本:1.0.0。任务 → 新增/编辑 → 插件 API_CALL。
入口与准备
使用 ADMIN 创建、配置和保存任务;ADMIN 或 OPERATOR 可以执行已发布定义,详细日志和输入输出变量由 ADMIN 查看。资源必须启用并可被执行节点访问。任务公共超时、重试和版本规则见任务,角色动作见权限矩阵。
字段说明
“默认值”指 1.0.0 新建表单的初始值;空表示尚未填写,不表示必填项可以省略。显示条件决定当前分支中是否出现字段。“条件必填”只在对应分支启用时要求填写。
请求
| 字段 | 是否必填 | 默认值 | 显示条件 | 作用范围 |
|---|---|---|---|---|
| 服务资源 | 必填 | 无 | 始终 | 当前任务版本 |
| 请求方法 | 有默认值 | POST | HTTP | 当前任务版本 |
| 请求路径(可选) | 可选 | 空 | HTTP | 当前任务版本 |
| 请求头 | 可选 | 空 | 始终 | 当前任务版本 |
| 请求体(JSON) | 可选 | 空 | HTTP 且非 GET/HEAD | 当前任务版本 |
- 服务资源:协议、认证和连接超时来自资源。
- 请求方法:GET/POST/PUT/PATCH/DELETE/HEAD/OPTIONS。
- 请求路径(可选):相对服务地址;留空使用资源地址;查询参数放路径。
- 请求头:最多 100 个;遵循保留/替换已有敏感头的表单行为。
- 请求体(JSON):JSON 对象、数组或基本值;GET/HEAD 不发送请求体。
SOAP
| 字段 | 是否必填 | 默认值 | 显示条件 | 作用范围 |
|---|---|---|---|---|
| 操作名称 | 条件必填 | 空 | SOAP | 当前任务版本 |
| SOAPAction(动作头) | 可选 | 空 | SOAP | 当前任务版本 |
| 参数 | 可选 | 空 | SOAP | 当前任务版本 |
- 操作名称:SOAP 1.1,POST。
- SOAPAction(动作头):SOAPAction。
- 参数:命名参数,由客户端生成 XML。
响应
| 字段 | 是否必填 | 默认值 | 显示条件 | 作用范围 |
|---|---|---|---|---|
| 响应上限(字节) | 有默认值 | 1048576 | 高级配置 | 当前任务版本 |
| 业务成功条件 | 可选 | 关闭 | HTTP JSON 响应 | 当前任务版本 |
| JSONPath | 条件必填 | 空 | 启用业务成功条件 | 当前任务版本 |
| 比较方式 | 有默认值 | EQ | 启用业务成功条件 | 当前任务版本 |
| 预期值 | 条件必填 | 空 | 启用业务成功条件 | 当前任务版本 |
| 变量名 | 条件必填 | 空 | 新增响应变量提取 | 当前任务版本 |
| JSONPath | 条件必填 | 空 | 新增响应变量提取 | 当前任务版本 |
- 响应上限(字节):1024–16777216 字节。
- 业务成功条件:HTTP 2xx 后仍需满足业务条件。
- JSONPath:JSONPath。
- 比较方式:EQ/NE/GT/LT。
- 预期值:与提取结果比较。
- 变量名:输出变量名;最多 64 个提取器。
- JSONPath:JSONPath。
远端停止
| 字段 | 是否必填 | 默认值 | 显示条件 | 作用范围 |
|---|---|---|---|---|
| 远端停止(可选) | 可选 | 关闭 | 高级配置 | 当前任务版本 |
| 停止请求路径 | 条件必填 | 空 | 启用 HTTP 远端停止 | 当前任务版本 |
| 停止请求总期限(秒) | 有默认值 | 5 | 启用远端停止 | 当前任务版本 |
| 远端停止请求体 | 可选 | 空 | 启用 HTTP 远端停止 | 当前任务版本 |
- 远端停止(可选):与主请求相同协议,需共享业务操作标识。
- 停止请求路径:相对路径;不自动重试。
- 停止请求总期限(秒):1–30 秒。
- 远端停止请求体:按远端取消协议提供。
使用边界
- 普通文本字段插值后得到文本;JSON中单一占位符可以保留原值类型。
- 主调用收到HTTP 503时不会触发本插件自动重试。
- 远端停止请求被受理不保证业务停止或回滚。
典型配置:提取订单接口汇总
按下表填写界面,资源名称需替换为自己的已启用资源。这是配置说明,不是可直接导入的 JSON。完整数据准备与执行步骤见本节末尾教程。
先运行链接教程中的HTTP样例服务,并让Worker可以访问它;/orders/summary默认返回total=3、amount=600。
| 配置项 | 填写内容 |
|---|---|
| 服务资源 | 教程中启动的HTTP服务资源 |
| 请求方法 | GET |
| 请求路径 | /orders/summary |
| 响应变量1 | 变量名total;JSONPath $.total |
| 响应变量2 | 变量名amount;JSONPath $.amount |
预期结果: 接口返回 {"total":3,"amount":600},输出变量 total=3、amount=600。
跟做完整教程。保存定义后再手动执行;实例状态与业务结果分别核对。
技术字段对照
以下键名用于导入配置、接口或排障。规则中的 [] 表示集合元素;不需要把这些键名填入界面标签。
| 类别 / 字段 | 技术键名 |
|---|---|
| 请求 / 服务资源 | resourceId |
| 请求 / 请求方法 | method |
| 请求 / 请求路径(可选) | path |
| 请求 / 请求头 | headers |
| 请求 / 请求体(JSON) | body |
| SOAP / 操作名称 | webService.operation |
| SOAP / SOAPAction(动作头) | webService.action |
| SOAP / 参数 | webService.parameters |
| 响应 / 响应上限(字节) | maxResponseBytes |
| 响应 / 业务成功条件 | successCondition |
| 响应 / JSONPath | successCondition.expression |
| 响应 / 比较方式 | successCondition.operator |
| 响应 / 预期值 | successCondition.expected |
| 响应 / 变量名 | extractors[].variable |
| 响应 / JSONPath | extractors[].expression |
| 远端停止 / 远端停止(可选) | remoteStop |
| 远端停止 / 停止请求路径 | remoteStop.path |
| 远端停止 / 停止请求总期限(秒) | remoteStop.timeoutSeconds |
| 远端停止 / 远端停止请求体 | remoteStop.body |