GetWorkflowInstance - 获取工作流实例详情--AI 数据湖服务-火山引擎

文档中心

导航

GetWorkflowInstance - 获取工作流实例详情

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

获取工作流实例详情

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetWorkflowInstance	要执行的操作，取值：GetWorkflowInstance。
Version	String	是	2025-08-15	API的版本，取值：2025-08-15。
WorkflowInstanceId	String	是	wf-tpl-xxx-yy	工作流实例id

返回参数

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

参数	类型	示例值	描述
Name	String	workflow_instance_name	工作流实例名称
Status	String	Running	工作流实例状态
EndTime	String	2025-08-15T10:00:00Z	任务结束时间
StartTime	String	2025-08-15T10:00:00Z	任务开始时间
UpdateTime	String	2025-08-15T10:00:00Z	任务更新时间
TriggerType	String	Manual	触发类型
WorkflowInstanceId	String	wf-tpl-ea241ccb342e79e995c6-k8cnc	工作流实例id
RunEnvs	Array of Object	[ { "Name": "n1", "Value": "v1" } ]	作业运行环境变量

请求示例

POST https://open.volcengineapi.com
{
    "WorkflowInstanceId": "wf-tpl-xxx-yy"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "GetWorkflowInstance",
        "Region": "cn-beijing",
        "Service": "las",
        "Version": "2025-08-15",
        "RequestId": "20230604110420****100232280022D31",
        "Deprecated": true
    },
    "Result": {
        "WorkflowInstanceId": "wwf-tpl-xxx-yy",
        "Name": "workflow_instance_name",
        "Status": "Running",
        "StartTime": "2025-08-15T10:00:00Z",
        "UpdateTime": "2025-08-15T10:00:00Z",
        "EndTime": "2025-08-15T10:00:00Z",
        "TriggerType": "Manual",
        "Result": "{}"
    }
}

错误码

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

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