数据开发治理平台 WeData 获取工作流调度信息

1. 接口描述

接口请求域名： wedata.tencentcloudapi.com 。

获取工作流信息

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：GetWorkflow。
Version	是	String	公共参数，本接口取值：2025-08-06。
Region	是	String	公共参数，详见产品支持的地域列表。
ProjectId	是	String	项目ID 示例值：2860707393964244992
WorkflowId	是	String	工作流ID 通过ListWorkflows接口获取示例值：0b785b8d-bd8e-4513-be65-36f989bc8a64 取值可参考：查询工作流列表

3. 输出参数

参数名称	类型	描述
Data	WorkflowDetail	工作流详细信息注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功

查询工作流信息成功

输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetWorkflow
<公共请求参数>

{
    "ProjectId": "1486804694126882816",
    "WorkflowId": "0b785b8d-bd8e-4513-be65-36f989bc8a64"
}

输出示例

{
    "Response": {
        "Data": {
            "BundleId": null,
            "BundleInfo": null,
            "CreateUserUin": "100043191163",
            "OwnerUin": "100043191163",
            "Path": "/u9ed8u8ba4u6587u4ef6u5939/u6620u5c04u573au666f2",
            "WorkflowDesc": "",
            "WorkflowName": "u6620u5c04u573au666f2",
            "WorkflowParams": [],
            "WorkflowSchedulerConfiguration": {
                "CalendarId": "105",
                "CalendarName": "u4ea4u6613u6240u65e5u5386",
                "CalendarOpen": "1",
                "CrontabExpression": "0 0 0 * * ?",
                "CycleType": "HOUR_CYCLE",
                "DependencyWorkflow": "no",
                "EndTime": "2099-12-31 23:59:59",
                "ExecutionEndTime": "23:59",
                "ExecutionStartTime": "00:00",
                "ScheduleTimeZone": "UTC+8",
                "SelfDepend": "serial",
                "StartTime": "2025-09-11 00:00:00"
            },
            "WorkflowType": "cycle"
        },
        "RequestId": "c1ee28f6-319f-43aa-8fa5-a26d2865518e"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

获取工作流调度信息

本页目录：