1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
查询工作流画布
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeWorkflowCanvasInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| WorkflowId | 是 | String | 工作流id 示例值：86f1fbd0-f0f0-11ee |
| ProjectId | 是 | String | 项目id 示例值：20231213212 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | WorkflowCanvasOpsDto | 工作流调度详情 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询工作流画布示例
查询工作流画布
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWorkflowCanvasInfo
<公共请求参数>
{
"WorkflowId": "your projectId",
"ProjectId": "86f1fbd0-f0f0-11ee"
}输出示例
{
"Response": {
"Data": {
"FolderId": "e01ef036-eeef-11ed-8d13-a",
"FolderIds": null,
"Links": [
{
"Id": "adfc6639-f0f8-11",
"InCharge": "jack",
"LinkDependencyType": "normal_all",
"LinkKey": "your taskId1_your taskId2",
"LinkType": "real_real",
"Offset": "1",
"TaskFrom": "your taskId1",
"TaskTo": "your taskId2",
"WorkflowId": "86f1fbd0-f0f0-11ee"
}
],
"Owner": "jack",
"OwnerId": "10001111",
"ProjectId": "your projectId",
"ProjectIdent": "project_wedata",
"ProjectName": "project_wedata",
"Tasks": [
{
"BrokerIp": "any",
"ClusterId": null,
"CreateTime": "2024-04-02 20:57:42",
"Creator": "jack",
"Crontab": null,
"CrontabExpression": null,
"CycleNum": null,
"CycleStep": 5,
"CycleType": "MINUTE_CYCLE",
"CycleUnit": null,
"DelayTime": 0,
"DependencyRel": "and",
"DependencyWorkflow": "no",
"EndDate": null,
"EndTime": "2024-04-02 23:59:59",
"EventListenerConfig": null,
"EventPublisherConfig": null,
"ExecutionEndTime": "23:59",
"ExecutionStartTime": "00:00",
"ExecutionTTL": -1,
"ExecutorGroupId": null,
"ExecutorGroupName": null,
"FirstRunTime": null,
"FirstSubmitTime": null,
"FolderId": null,
"FolderName": null,
"InCharge": "jack",
"InChargeId": "10001111",
"InitStrategy": null,
"InstanceInitStrategy": "T_PLUS_0",
"LastSchedulerCommitTime": null,
"LastUpdate": "2024-04-10 23:41:00",
"Layer": null,
"LeftCoordinate": 282,
"MaxDateTime": null,
"MinDateTime": null,
"NormalizedJobStartTime": null,
"Notes": "",
"OwnId": "1000284123123",
"ProductName": "DATA_DEV",
"ProjectId": "your projectId",
"ProjectIdent": null,
"ProjectName": "project_wedata",
"RealWorkflowId": null,
"ResourceGroup": "202402012229424",
"RetryAble": 1,
"RetryWait": 0,
"RunPriority": 4,
"ScheduleDesc": null,
"SchedulerDesc": "从2024年04月02日 00:00:00开始,每天00:00~23:59内，每间隔5分钟执行一次",
"SelfDepend": "serial",
"ShowWorkflow": false,
"SourceServiceId": null,
"SourceServiceType": null,
"StartDate": null,
"StartTime": "2024-04-02 00:00:00",
"StartupTime": 0,
"Status": "F",
"TargetServiceId": null,
"TargetServiceType": null,
"TaskAction": "",
"TaskId": "your taskId2",
"TaskLinkInfo": null,
"TaskName": "retry_01",
"TaskType": {
"TypeDesc": "Shell",
"TypeId": 35,
"TypeSort": "数据计算"
},
"TaskTypeDesc": null,
"TaskTypeId": null,
"TenantId": "1342333051789",
"TopCoordinate": 294,
"TryLimit": 1,
"UpdateTime": "2024-04-02 20:58:55",
"UpdateUser": "jack",
"UpdateUserId": "10001111",
"UserId": "10001111",
"VirtualFlag": false,
"VirtualTaskId": null,
"VirtualTaskStatus": null,
"WorkflowId": "86f1fbd0-f0f0-11ee",
"WorkflowName": "qm_0402",
"YarnQueue": null,
"TasksStr": "TasksStr",
"Submit": true
},
{
"BrokerIp": "any",
"ClusterId": null,
"CreateTime": "2024-04-02 20:59:12",
"Creator": "jack",
"Crontab": null,
"CrontabExpression": null,
"CycleNum": null,
"CycleStep": 5,
"CycleType": "MINUTE_CYCLE",
"CycleUnit": null,
"DelayTime": 0,
"DependencyRel": "and",
"DependencyWorkflow": "no",
"EndDate": null,
"EndTime": "2024-04-02 23:59:59",
"EventListenerConfig": null,
"EventPublisherConfig": null,
"ExecutionEndTime": "23:59",
"ExecutionStartTime": "00:00",
"ExecutionTTL": -1,
"ExecutorGroupId": null,
"ExecutorGroupName": null,
"FirstRunTime": null,
"FirstSubmitTime": null,
"FolderId": null,
"FolderName": null,
"InCharge": "jack",
"InChargeId": "10001111",
"InitStrategy": null,
"InstanceInitStrategy": "T_PLUS_0",
"LastSchedulerCommitTime": null,
"LastUpdate": "2024-04-10 23:41:00",
"Layer": null,
"LeftCoordinate": 540,
"MaxDateTime": null,
"MinDateTime": null,
"NormalizedJobStartTime": null,
"Notes": "",
"OwnId": "1000284123123",
"ProductName": "DATA_DEV",
"ProjectId": "your projectId",
"ProjectIdent": null,
"ProjectName": "project_wedata",
"RealWorkflowId": null,
"ResourceGroup": "2024020122294",
"RetryAble": 1,
"RetryWait": 1,
"RunPriority": 6,
"ScheduleDesc": null,
"SchedulerDesc": "从2024年04月02日 00:00:00开始,每天00:00~23:59内，每间隔5分钟执行一次",
"SelfDepend": "serial",
"ShowWorkflow": false,
"SourceServiceId": null,
"SourceServiceType": null,
"StartDate": null,
"StartTime": "2024-04-02 00:00:00",
"StartupTime": 0,
"Status": "F",
"TargetServiceId": null,
"TargetServiceType": null,
"TaskAction": "",
"TaskId": "2024040220591",
"TaskLinkInfo": null,
"TaskName": "retry_02",
"TaskType": {
"TypeDesc": "Shell",
"TypeId": 35,
"TypeSort": "数据计算"
},
"TaskTypeDesc": null,
"TaskTypeId": null,
"TenantId": "1342333051789",
"TopCoordinate": 343,
"TryLimit": 2,
"UpdateTime": "2024-04-02 20:59:43",
"UpdateUser": "jack",
"UpdateUserId": "10001111",
"UserId": "10001111",
"VirtualFlag": false,
"VirtualTaskId": null,
"VirtualTaskStatus": null,
"WorkflowId": "86f1fbd0-f0f0-11ee",
"WorkflowName": "qm_0402",
"YarnQueue": null,
"TasksStr": "TasksStr",
"Submit": true
},
{
"BrokerIp": "any",
"ClusterId": null,
"CreateTime": "2024-04-02 21:00:03",
"Creator": "jack",
"Crontab": null,
"CrontabExpression": null,
"CycleNum": null,
"CycleStep": 1,
"CycleType": "DAY_CYCLE",
"CycleUnit": null,
"DelayTime": 0,
"DependencyRel": "and",
"DependencyWorkflow": "no",
"EndDate": null,
"EndTime": "2099-12-31 23:59:59",
"EventListenerConfig": null,
"EventPublisherConfig": null,
"ExecutionEndTime": "23:59",
"ExecutionStartTime": "00:00",
"ExecutionTTL": -1,
"ExecutorGroupId": null,
"ExecutorGroupName": null,
"FirstRunTime": null,
"FirstSubmitTime": null,
"FolderId": null,
"FolderName": null,
"InCharge": "jack",
"InChargeId": "10001111",
"InitStrategy": null,
"InstanceInitStrategy": "T_PLUS_0",
"LastSchedulerCommitTime": null,
"LastUpdate": "2024-04-10 23:41:00",
"Layer": null,
"LeftCoordinate": 386,
"MaxDateTime": null,
"MinDateTime": null,
"NormalizedJobStartTime": null,
"Notes": "",
"OwnId": "1000284123123",
"ProductName": "DATA_DEV",
"ProjectId": "your projectId",
"ProjectIdent": null,
"ProjectName": "project_wedata",
"RealWorkflowId": null,
"ResourceGroup": "2024040221030",
"RetryAble": 1,
"RetryWait": 5,
"RunPriority": 6,
"ScheduleDesc": null,
"SchedulerDesc": "每天00:00执行一次",
"SelfDepend": "serial",
"ShowWorkflow": false,
"SourceServiceId": ";29243;",
"SourceServiceType": ";tdsqlc;",
"StartDate": null,
"StartTime": "2024-04-02 00:00:00",
"StartupTime": 0,
"Status": "F",
"TargetServiceId": null,
"TargetServiceType": null,
"TaskAction": "",
"TaskId": "your taskId1",
"TaskLinkInfo": null,
"TaskName": "tdsql_c_mysql",
"TaskType": {
"TypeDesc": "JDBC SQL",
"TypeId": 21,
"TypeSort": "数据计算"
},
"TaskTypeDesc": null,
"TaskTypeId": null,
"TenantId": "13150",
"TopCoordinate": 210,
"TryLimit": 5,
"UpdateTime": "2024-04-02 21:18:01",
"UpdateUser": "jack",
"UpdateUserId": "10001111",
"UserId": "10001111",
"VirtualFlag": false,
"VirtualTaskId": null,
"VirtualTaskStatus": null,
"WorkflowId": "86f1fbd0-f0f0-11ee",
"WorkflowName": "qm_0402",
"YarnQueue": null,
"TasksStr": "TasksStr",
"Submit": true
}
],
"UserGroupId": "",
"UserGroupName": "",
"WorkflowDesc": "",
"WorkflowId": "86f1fbd0-f0f0-11ee",
"WorkflowName": "qm_0402"
},
"RequestId": "64926868-c383-4718-a128-fc555782dc18"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |