创建工作流的异步运行实例

最近更新时间:2025-06-13 01:45:31

我的收藏

1. 接口描述

接口请求域名: lke.tencentcloudapi.com 。

本接口用来创建工作流的异步运行实例,创建成功后工作流会在后台异步运行,接口返回工作流运行实例ID(WorkflowRunId)等信息。后面可通过调用DescribeWorkflowRun接口查工作流运行的详情。
注意:工作流的异步运行是基于应用的,需要先把对应的应用配置成“单工作流模式”,并且打开“异步调用”的开关,才能创建成功。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateWorkflowRun。
Version String 公共参数,本接口取值:2023-11-30。
Region String 公共参数,详见产品支持的 地域列表
RunEnv Integer 运行环境。0: 测试环境; 1: 正式环境
示例值:1
AppBizId String 应用ID
示例值:1854548189164339200
Query String 用户输入的内容
示例值:我想订明天的酒店
CustomVariables.N Array of CustomVariable API参数配置
示例值:[{"Name": "name", "Value":"张三"}}]

3. 输出参数

参数名称 类型 描述
AppBizId String 应用ID
示例值:1854548189164339200
WorkflowRunId String 工作流运行实例的ID
示例值:8ad82e0553507b4c1ba771fb53029492
RunEnv Integer 运行环境。0: 测试环境; 1: 正式环境
示例值:1
Query String 用户输入的内容
示例值:我想订明天的酒店
CustomVariables Array of CustomVariable API参数配置
示例值:[{"Name": "name", "Value":"张三"}}]
CreateTime String 创建时间(毫秒时间戳)
示例值:1744707612000
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建工作流的异步运行实例

针对运行时间比较长的工作流的场景。步骤:在平台上创建好符合条件(不含参数提取节点、选项卡节点和回复节点)的工作流并调试通过,编辑应用设置成“单工作流模式”,选择工作流,打开“异步调用”的开关,然后再调用本接口。

输入示例

复制
复制成功
POST / HTTP/1.1
Host: lke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWorkflowRun
<公共请求参数>

{
    "RunEnv": 1,
    "AppBizId": "1854548189164339200",
    "Query": "发起任务",
    "CustomVariables": [
        {
            "Name": "name",
            "Value": "张三"
        }
    ]
}

输出示例

复制
复制成功
{
    "Response": {
        "RequestId": "42c23cf3-0dbb-4676-a5a0-bb9cb0787f5d",
        "AppBizId": "1854548189164339200",
        "WorkflowRunId": "67c23cf3-077b-4644-225a0-bb9cb078322",
        "RunEnv": 1,
        "CreateTime": "1672531200000",
        "Query": "发起任务",
        "CustomVariables": [
            {
                "Name": "name",
                "Value": "张三"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
MissingParameter 缺少参数错误。

如果遇到产品相关问题,您可咨询 在线客服寻求帮助。

返回顶部