查看任务测试资源样例

读取当前任务测试资源中的文件、表结构和行样例。相关对象、变量及环境边界见公共说明。

POST https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-test-scratch/observe

调用前准备

在当前生成任务执行环境中保留注入的服务地址、凭据、工作区和短期授权。授权头使用完整原值。安装 jq 并设置示例所用变量。

请求体

curl -X POST "${MOI_ENDPOINT%/}/workflow/v2/workflow-test-scratch/observe" \
  -H "X-API-Key: $MOI_API_KEY" \
  -H "X-Workspace-ID: $MOI_WORKSPACE_ID" \
  -H "X-MOI-Runtime-Authorization: $MOI_RUNTIME_AUTHORIZATION" \
  -H 'Content-Type: application/json' \
  --data-binary "$(jq -n  '{}')"

此接口先调用 EnsureScratch,尚无资源时可能创建测试数据库和卷,再读取文件与表样例。它不是只读的健康查询。卷文件一次最多取 1000 条,表最多取 100 行;检查 total、row_count 和 truncated,不把样例当作全集。普通身份路径的范围条件与准备接口相同。

字段

类型

是否必填

说明

task_id

string

任务模式可省略

由校验后的任务身份取得;显式值必须一致。

context_id

string

任务模式可省略

由校验后的任务身份取得;显式值必须一致。

effective_role_id

string

任务模式可省略

由校验后的任务身份取得;显式值必须一致。

catalog_id

integer

否

创建资源的 Catalog;0 时解析默认 Catalog,解析后必须为正数。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "scope": "current_task",
    "database_name": "scratch_example",
    "volumes": [
      {
        "volume_id": 12,
        "files": [],
        "total": 0,
        "truncated": false
      },
      {
        "volume_id": 13,
        "files": [],
        "total": 0,
        "truncated": false
      }
    ],
    "tables": []
  }
}

字段

类型

说明

code

string

成功时为 OK。

msg

string

响应信息。

data

object

本动作结果。

data.scope

string

观察范围;具体值由服务端返回。

data.database_name

string

测试数据库。

data.volumes

object[]

输入与输出卷的文件样例。

data.volumes[].volume_id

integer

卷 ID。

data.volumes[].files

object[]

当前取得的文件清单;文件对象另需核对 Catalog 定义。

data.volumes[].total

integer

卷文件总数。

data.volumes[].truncated

boolean

当前文件清单是否少于总数。

data.tables

object[]

表结构与行样例。

data.tables[].name

string

表名。

data.tables[].columns

object[]

列名与数据类型。

data.tables[].row_count

integer

表总行数。

data.tables[].rows

array[]

行值;保留 SQL 驱动返回的 JSON 标量类型。

data.tables[].truncated

boolean

行样例是否少于总行数。

错误响应

按 HTTP 状态和业务字段处理。历史查询与恢复另有专用错误代码,见错误与环境。先保留身份、来源引用和操作标识,核对状态后处理;不自动改换工作区、候选或确认键。

最后更新于