触发文件工作流¶
触发与指定文件关联的工作流,并返回实际触发的数量。
POST https://api.moi.matrixorigin.cn/v5/catalog/file/trigger_workflow
调用前准备¶
先查询文件列表取得目标文件和所属卷。准备可访问目标工作区的个人访问令牌、目标工作区 ID、卷 ID 和文件 ID 列表。
确认当前身份具有目标卷的 volume.read 权限和绑定工作流的 workflow.run 权限。
选择非保留卷。
请求体¶
curl -X POST "https://api.moi.matrixorigin.cn/v5/catalog/file/trigger_workflow" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H "Content-Type: application/json" \
-d '{
"volume_id": '"$VOLUME_ID"',
"file_ids": ["'"$FILE_ID"'"]
}'
执行时使用绑定中保存的创建者、角色、版本和计算配置。
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer |
是 |
文件所属根卷 ID。 |
|
string(字符串数组) |
是 |
1 至 1000 个不重复文件 ID,均须实际挂载在指定 volume_id 下。 |
成功响应¶
{
"code": "OK",
"msg": "OK",
"data": {
"triggered": 1
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
integer |
已创建的持久派发记录数,即触发器与文件配对数。不是不同工作流数量,也不表示执行完成。 |
错误响应¶
{
"code": "ErrParamInvalid",
"msg": "请求参数无效"
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
错误信息。 |
最后更新于