帮你快速理解、总结文档立即下载

获取工作流详细信息

最近更新时间:2026-09-11 14:18:55
我的收藏

1. 接口描述

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

获取工作流详细信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetWorkflow。
Version String 公共参数,本接口取值:2026-07-15。
Region String 公共参数,详见产品支持的 地域列表
WorkspaceId String

工作空间ID,可通过 ListWorkspaces 获取。必填


示例值:17697410068842890
WorkflowId String

工作流ID,可通过 ListWorkflows 获取。必填


示例值:8e0e3485-2736-4530-92ed-932e019898f1

3. 输出参数

参数名称 类型 描述
Data GetWorkflowRsp

获取工作流详细信息响应内容


注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取工作流详细信息

输入示例

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

{
    "WorkspaceId": "17697410068842890",
    "WorkflowId": "8e0e3485-2736-4530-92ed-932e019898f1"
}

输出示例

{
    "Response": {
        "Data": {
            "AdvanceConfig": {
                "MaxConcurrentNum": 1,
                "QueuingMode": "OFF"
            },
            "BaseInfo": {
                "CreateTime": "1786100692847",
                "CreateUserUin": "700002164618",
                "OwnerDisplayName": "we***a**-d**@t*n********",
                "OwnerUserName": "wed**a*0*d**************",
                "OwnerUserUin": "700002164618",
                "RunUserUin": "700002164618",
                "UpdateTime": "1786115139666",
                "WorkflowId": "8e0e3485-2736-4530-92ed-932e019898f1",
                "WorkflowName": "new_workflow_20260807_190451"
            },
            "BundleId": "",
            "BundleInfo": "",
            "GitConfigId": "",
            "LabelList": [],
            "ParamList": [
                {
                    "ParamId": "d667305e-a68c-4661-93ea-cad9c9f1ce9c",
                    "ParamKey": "pppp1",
                    "ParamValue": "vvvv1"
                }
            ],
            "TaskList": [
                {
                    "CreateTime": "1786100692847",
                    "CreateUserUin": "700002164618",
                    "DependOnList": [],
                    "DependOnRunCondition": "ALL_SUCCESS",
                    "LeftCoordinate": 50,
                    "ParamList": [],
                    "ResourceGroupId": "res-ea1a38f8",
                    "TaskId": "40d34e5c-12d9-4ac3-88ed-2f879713d4e4",
                    "TaskName": "py_08072",
                    "TaskRetryStrategy": {
                        "MaxRetryTimes": 3,
                        "RetryBetweenWaitTime": 5,
                        "RetryBetweenWaitTimeUnit": "SECOND",
                        "TaskRunFailureRetrySwitch": true,
                        "TaskRunTimeoutRetrySwitch": false
                    },
                    "TaskType": {
                        "RuntimePropertyList": [
                            {
                                "PropertyKey": "ConfigType",
                                "PropertyValue": "DEFAULT"
                            }
                        ],
                        "TaskTypeName": "PYTHON",
                        "TaskTypePropertyList": [
                            {
                                "PropertyKey": "Source",
                                "PropertyValue": "5"
                            }
                        ]
                    },
                    "TopCoordinate": 50,
                    "UpdateTime": "1786115139765"
                }
            ],
            "Trigger": [],
            "WorkspaceId": "17697410068842890"
        },
        "RequestId": "a225ce2c-c8dd-47bc-83c1-df352a949443"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.WorkflowNoPermission 无操作权限
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.ParamBlankError 参数 <parameter> 不能为空。
MissingParameter 缺少参数错误。
ResourceNotFound.WorkflowNotFound ResourceNotFound.WorkflowNotFound