更新自定义算子

修改一个自定义算子的配置或代码。启用状态不能通过此接口修改,请使用专门的启用或停用操作。

PUT https://moi.matrixorigin.cn/newmoi/workflow/v2/custom-operators/$OPERATOR_ID

调用前准备

查看自定义算子列表,选择一个算子并取得自定义算子 ID;再查看自定义算子详情,确认要修改的配置。将该 ID 写入路径参数 operator_id。准备有目标工作区访问权限的个人访问令牌目标工作区 ID,分别通过 X-API-KeyX-Workspace-ID 请求头传递。

不能通过此接口修改算子类型、版本或启用状态。要改变类型或版本,请创建新的自定义算子;要改变启用状态,请使用启用自定义算子停用自定义算子

请求体

所有字段均为可选;仅提交要修改的字段。

curl -X PUT "https://moi.matrixorigin.cn/newmoi/workflow/v2/custom-operators/$OPERATOR_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "统计输入文本的字符数,并返回结果。",
    "code": "def handle(workspace_id, sdk, input):\n    return {\"count\": len(input[\"text\"])}"
  }'

字段

类型

是否必填

说明

operator_id

integer

必填

要更新的自定义算子 ID。

description

string

算子说明。

code

string

源代码。

name

string

算子名称。

language

string

算子实现语言。

handler

string

算子处理函数。

isolation_level

string

算子隔离配置。

input_schema

object

输入定义。

output_schema

object

输出定义。

source_file_id

string

源文件 ID。

base_node_id

string

基础算子 ID。

base_node_version

string

基础算子版本。

binding_config

object

绑定配置。

catalog_id

integer

关联的 Catalog ID。

database_id

integer

关联的数据库 ID。

成功响应

响应返回更新后的算子配置。

响应字段如下。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": 123,
    "node_id": "moi:custom.operator:workspace:text_counter",
    "name": "文本计数",
    "description": "统计输入文本的字符数,并返回结果。",
    "identifier": "text_counter",
    "language": 1,
    "kind": 1,
    "handler": "main.handle",
    "input_schema": "{\"type\":\"object\"}",
    "output_schema": "{\"type\":\"object\"}",
    "isolation_level": "PUBLIC",
    "catalog_id": 1,
    "database_id": 2,
    "enabled": true
  }
}

字段

类型

是否必填

说明

code

string

成功时为 OK。

msg

string

成功时为 OK。

data.id

integer

自定义算子 ID。

data.node_id

string

工作流中的算子 ID。

data.name

string

更新后的算子名称。

data.description

string

更新后的说明;有值时返回。

data.identifier

string

算子标识。

data.version

string

算子版本;有值时返回。

data.language

integer

算子实现语言代码。

data.kind

integer

算子类型代码。

data.handler

string

代码类型的处理函数;有值时返回。

data.input_schema

string

输入定义的序列化内容;有值时返回。

data.output_schema

string

输出定义的序列化内容;有值时返回。

data.isolation_level

string

算子隔离配置;有值时返回。

data.source_file_id

string

源文件 ID;有值时返回。

data.catalog_id

integer

关联的 Catalog ID;有值时返回。

data.database_id

integer

关联的数据库 ID;有值时返回。

data.created_at

integer

创建时间的 Unix 时间戳;有值时返回。

data.updated_at

integer

最近更新时间的 Unix 时间戳;有值时返回。

data.created_by

string

创建者标识;有值时返回。

data.updated_by

string

最近更新者标识;有值时返回。

data.enabled

boolean

当前启用状态。

错误响应

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

字段

类型

是否必填

说明

code

string

错误代码。

msg

string

可读错误信息。

data

null

错误响应中为 null。

后续操作

用同一自定义算子 ID 查看自定义算子详情确认更新结果。

最后更新于