查看工作流算子列表¶
查看当前工作区可用于工作流的算子。选择一个算子后,可继续查看它的可用版本、输入和输出定义。
GET https://moi.matrixorigin.cn/newmoi/workflow/v2/workitems/catalog
调用前准备¶
调用示例¶
将 $AI_STUDIO_API_KEY 和 $WORKSPACE_ID 替换为实际值。
curl "https://moi.matrixorigin.cn/newmoi/workflow/v2/workitems/catalog" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
此接口没有业务参数。
成功响应¶
成功时返回当前工作区可用的算子列表。后续调用使用列表中的算子 ID,不要以显示名称代替算子 ID。
{
"code": "OK",
"msg": "OK",
"data": {
"items": [
{
"node_id": "moi:data.sql.process",
"display_name": "SQL 处理",
"category": "data_processing",
"preferred_version": "v1",
"stream": false
}
],
"total": 1
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
object |
响应数据。 |
|
array of object |
可用算子列表。 |
|
integer |
返回的算子总数。 |
下面表格展开响应示例中 data 下的 items 列表;每一行是列表中一个算子的字段。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
算子 ID,可用于查看详情或发布 API 服务。 |
|
string |
算子显示名称。 |
|
string |
算子简短说明;有值时返回。 |
|
string |
算子所属分类;有值时返回。 |
|
array of string |
算子标签;有值时返回。 |
|
string |
算子来源;有值时返回。 |
|
string |
算子提供方;有值时返回。 |
|
string |
推荐使用的版本;有值时返回。 |
|
string |
可见性;有值时返回。 |
|
boolean |
是否为流式算子。 |
错误响应¶
{
"code": "ErrForbidden",
"msg": "没有权限",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
可读错误信息。 |
|
null |
错误响应中为 |
后续操作¶
选择一个条目并记录算子 ID 后,查看工作流算子详情以选择具体版本。
最后更新于