RunWorkflowInstance - 运行工作流实例--AI 数据湖服务-火山引擎

文档中心

导航

RunWorkflowInstance - 运行工作流实例

最近更新时间：2025.11.12 15:08:08首次发布时间：2025.11.12 15:08:08

运行工作流实例

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	RunWorkflowInstance	要执行的操作，取值：RunWorkflowInstance。
Version	String	是	2025-08-15	API的版本，取值：2025-08-15。
Name	String	是	workflow_instance_name	工作流实例名称
WorkflowId	String	是	wf-tpl-xxx	工作流id
ClientToken	String	否	xfasda	客户端token
RunEnvs	Array of Object	否	[ { "Name": "n1", "Value": "v1" } ]	工作流运行追加环境变量

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
WorkflowInstanceId	String	wf-tpl-xxx-yy	工作流实例id

请求示例

POST https://open.volcengineapi.com
{
    "Name": "workflow_instance_name",
    "WorkflowId": "wf-tpl-xxx",
    "ClientToken": ""
}

返回示例

{
    "Result": {
        "WorkflowInstanceId": "wf-tpl-xxx-yy"
    },
    "ResponseMetadata": {
        "Action": "RunWorkflowInstance",
        "Region": "cn-beijing",
        "Service": "las_ai_dev",
        "Version": "2025-08-15",
        "RequestId": "20230604110420****100232280022D31",
        "Deprecated": true
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidRequestParam	Invalid request param {}, cause {}	非法请求参数 {}, 原因 {}
400	DryRunOperation	The request is validated by a dryrun operation.	该请求通过 dryrun 操作进行验证。
400	InvalidParameter	The specified parameter {} is invalid.	指定的参数 {} 无效。
400	MissingParameter	The required parameter {} is missing.	缺少必需的参数 {}。
500	InternalError	The request has failed due to an unknown error.	由于未知错误，请求失败。