查询自定义算子列表

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

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

调用前准备

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

下方示例使用：

• $AI_STUDIO_API_KEY：实际个人访问令牌，通过 X-API-Key Header 传递。

• $WORKSPACE_ID：目标工作区 ID，通过 X-Workspace-ID Header 传递。

查询参数

参数	类型	是否必填	说明
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 筛选。

请求示例

curl "https://moi.matrixorigin.cn/newmoi/workflow/v2/custom-operators?page_size=20&enabled=true" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_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": 1
  }
}

响应字段如下。

本文中，字段路径中的 [] 表示数组中的每一项。例如，items[].name 表示 items 数组中每一项的 name 字段。

字段	类型	说明
code	string	成功时为 OK。
msg	string	成功时为 OK。
data.items[]	array	自定义算子列表。
data.items[].id	integer	自定义算子 ID，用于后续操作。
data.items[].node_id	string	工作流中的算子 ID。
data.items[].name	string	算子名称。
data.items[].identifier	string	算子标识。
data.items[].description	string	算子说明；有值时返回。
data.items[].handler	string	处理函数；有值时返回。
data.items[].version	string	算子版本；有值时返回。
data.items[].isolation_level	string	隔离配置；有值时返回。
data.items[].language	integer	实现语言的数值编码；有值时返回。
data.items[].kind	integer	算子类型的数值编码；有值时返回。
data.items[].source_file_id	string	源文件 ID；使用源文件创建时返回。
data.items[].input_schema	string	输入定义的序列化内容；有值时返回。
data.items[].output_schema	string	输出定义的序列化内容；有值时返回。
data.items[].binding_config	string	绑定配置的序列化内容；有值时返回。
data.items[].created_by	string	创建者标识；有值时返回。
data.items[].updated_by	string	最后更新者标识；有值时返回。
data.items[].created_at	integer	创建时间戳；有值时返回。
data.items[].updated_at	integer	最后更新时间戳；有值时返回。
data.items[].base_node_id	string	内置绑定类型关联的基础算子；有值时返回。
data.items[].base_node_version	string	内置绑定类型关联的基础算子版本；有值时返回。
data.items[].catalog_id	integer	关联的 Catalog ID；有值时返回。
data.items[].database_id	integer	关联的数据库 ID；有值时返回。
data.items[].enabled	boolean	算子是否已启用。
data.total	integer	符合筛选条件的总数。
data.next_page_token	string	下一页标记；无下一页时不返回。

错误响应

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

常见 HTTP 错误

HTTP 状态码	错误代码	常见原因	建议操作
400	ErrParamInvalid	page_size 不是正整数，或 enabled 不是布尔值。	修正查询参数后重试。
401	ErrUnauthorized	个人访问令牌缺失或无效。	检查个人访问令牌和工作区 ID。
403	ErrForbidden	当前身份没有读取自定义算子的权限。	使用有权限的凭据，或联系管理员授权。
500	ErrServer	服务暂时无法读取列表。	记录错误信息后重试。
503	ErrServiceUnavailable	依赖服务暂时不可用。	稍后重试。

后续操作

查询自定义算子详情。

最后更新于 2026 年 8 月 22 日