更新自定义算子¶
修改一个自定义算子的配置或代码。启用状态不能通过此接口修改,请使用专门的启用或停用操作。
PUT https://moi.matrixorigin.cn/newmoi/workflow/v2/custom-operators/$OPERATOR_ID
调用前准备¶
先查看自定义算子列表,选择一个算子并取得自定义算子 ID;再查看自定义算子详情,确认要修改的配置。将该 ID 写入路径参数 operator_id。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID,分别通过 X-API-Key 和 X-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\"])}"
}'
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer |
必填 |
要更新的自定义算子 ID。 |
|
string |
否 |
算子说明。 |
|
string |
否 |
源代码。 |
|
string |
否 |
算子名称。 |
|
string |
否 |
算子实现语言。 |
|
string |
否 |
算子处理函数。 |
|
string |
否 |
算子隔离配置。 |
|
object |
否 |
输入定义。 |
|
object |
否 |
输出定义。 |
|
string |
否 |
源文件 ID。 |
|
string |
否 |
基础算子 ID。 |
|
string |
否 |
基础算子版本。 |
|
object |
否 |
绑定配置。 |
|
integer |
否 |
关联的 Catalog 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
}
}
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
否 |
成功时为 OK。 |
|
string |
否 |
成功时为 OK。 |
|
integer |
否 |
自定义算子 ID。 |
|
string |
否 |
工作流中的算子 ID。 |
|
string |
否 |
更新后的算子名称。 |
|
string |
否 |
更新后的说明;有值时返回。 |
|
string |
否 |
算子标识。 |
|
string |
否 |
算子版本;有值时返回。 |
|
integer |
否 |
算子实现语言代码。 |
|
integer |
否 |
算子类型代码。 |
|
string |
否 |
代码类型的处理函数;有值时返回。 |
|
string |
否 |
输入定义的序列化内容;有值时返回。 |
|
string |
否 |
输出定义的序列化内容;有值时返回。 |
|
string |
否 |
算子隔离配置;有值时返回。 |
|
string |
否 |
源文件 ID;有值时返回。 |
|
integer |
否 |
关联的 Catalog ID;有值时返回。 |
|
integer |
否 |
关联的数据库 ID;有值时返回。 |
|
integer |
否 |
创建时间的 Unix 时间戳;有值时返回。 |
|
integer |
否 |
最近更新时间的 Unix 时间戳;有值时返回。 |
|
string |
否 |
创建者标识;有值时返回。 |
|
string |
否 |
最近更新者标识;有值时返回。 |
|
boolean |
否 |
当前启用状态。 |
错误响应¶
{
"code": "ErrParamInvalid",
"msg": "请求参数无效",
"data": null
}
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
否 |
错误代码。 |
|
string |
否 |
可读错误信息。 |
|
null |
否 |
错误响应中为 null。 |
后续操作¶
用同一自定义算子 ID 查看自定义算子详情确认更新结果。