查看自定义算子列表¶

查看当前工作区可读取的自定义算子。返回的算子 ID 可用于查看、修改、试运行或删除算子。

GET https://api.moi.matrixorigin.cn/v5/workflow/v2/custom-operators

调用前准备¶

准备具有目标工作区访问权限的个人访问令牌和目标工作区 ID。

调用示例¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和筛选条件替换为实际值。

调用示例

curl "https://api.moi.matrixorigin.cn/v5/workflow/v2/custom-operators?page_size=20&enabled=true" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

参数说明

参数	类型	是否必填	说明
`page_size`	integer	否	每页数量。
`page_token`	string	否	上一页响应返回的下一页标记。
`enabled`	boolean	否	按启用状态筛选。
`language`	string	否	按实现语言筛选。
`kind`	string	否	按算子类型筛选。
`node_id`	string	否	按算子 ID 筛选。
`identifier`	string	否	按算子标识筛选。
`version`	string	否	按算子版本筛选。
`base_node_id`	string	否	按基础算子 ID 筛选。

成功响应¶

成功时返回符合条件的自定义算子。响应中有下一页标记时，将其作为下一次请求的 page_token；未返回时表示已读取完毕。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "items": [
      {
        "id": 123,
        "node_id": "moi:custom.operator:workspace:text_counter",
        "name": "文本计数",
        "identifier": "text_counter",
        "version": "v1",
        "enabled": true
      }
    ],
    "total": 21,
    "next_page_token": "eyJvZmZzZXQiOjIwfQ"
  }
}

字段说明

通用字段

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	响应数据。
`items`	array of object	自定义算子列表。
`total`	integer	符合筛选条件的总数。
`next_page_token`	string	下一页标记；无下一页时不返回。

算子信息

下面表格展开响应示例中 data 下的 items 列表；每一行是列表中一个自定义算子的字段。

字段	类型	说明
`id`	integer	自定义算子 ID，用于后续操作。
`node_id`	string	工作流中的算子 ID。
`name`	string	算子名称。
`identifier`	string	算子标识。
`description`	string	算子说明；有值时返回。
`handler`	string	处理函数；有值时返回。
`version`	string	算子版本；有值时返回。
`isolation_level`	string	隔离配置；有值时返回。
`language`	integer	实现语言的数值编码；有值时返回。
`kind`	integer	算子类型的数值编码；有值时返回。
`enabled`	boolean	算子是否已启用。

配置与来源

字段	类型	说明
`source_file_id`	string	源文件 ID；使用源文件创建时返回。
`input_schema`	string	输入定义的序列化内容；有值时返回。
`output_schema`	string	输出定义的序列化内容；有值时返回。
`binding_config`	string	绑定配置的序列化内容；有值时返回。
`base_node_id`	string	内置绑定类型关联的基础算子；有值时返回。
`base_node_version`	string	内置绑定类型关联的基础算子版本；有值时返回。
`catalog_id`	integer	关联的 Catalog ID；有值时返回。
`database_id`	integer	关联的数据库 ID；有值时返回。
`created_by`	string	创建者标识；有值时返回。
`updated_by`	string	最后更新者标识；有值时返回。
`created_at`	integer	创建时间戳；有值时返回。
`updated_at`	integer	最后更新时间戳；有值时返回。

错误响应¶

响应示例

{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	可读错误信息。
`data`	null	错误响应中为 `null`。

后续操作¶

选择一个条目并记录自定义算子 ID 后，查看自定义算子详情。

最后更新于 2026 年 9 月 11 日