1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
拉取dag实例
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DagInstances。 |
Version | 是 | String | 公共参数,本接口取值:2021-08-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Instances.N | 否 | Array of InstanceOpsDto | 实例列表 示例值:[{"TaskId":"20230313145623119","CurRunDate":"2023-03-1314:55:53"}] |
CheckFather | 否 | Boolean | 检查父任务类型, true: 检查父任务; false: 不检查父任务 示例值:false |
RerunType | 否 | String | 重跑类型, 1: 自身; 3: 孩子; 2: 自身以及孩子 示例值:1 |
DependentWay | 否 | String | 实例依赖方式, 1: 自依赖; 2: 任务依赖; 3: 自依赖及父子依赖 示例值:1 |
SkipEventListening | 否 | Boolean | 重跑忽略事件监听与否 示例值:true |
SonInstanceType | 否 | String | 下游实例范围 1: 所在工作流 2: 所在项目 3: 所有跨工作流依赖的项目 示例值:2 |
SearchCondition | 否 | InstanceApiOpsRequest | 查询条件,当前接口需要把要查询的示例信息放在该字段 示例值:{"Instance":{"TaskId":"20230313145623119","CurRunDate":"2023-03-1314:55:53"},"DagType":"1","DagDependent":"3","DagDepth":1} |
OptType | 否 | String | 访问类型 示例值:1 |
OperatorName | 否 | String | 操作者名称 示例值:"tom" |
OperatorId | 否 | String | 操作者id 示例值:"12344" |
ProjectId | 否 | String | 项目id 示例值:"2324234235343" |
ProjectIdent | 否 | String | 项目标志 示例值:"test_pro" |
ProjectName | 否 | String | 项目名称 示例值:"测试项目" |
PageIndex | 否 | Integer | 索引页码 示例值:1 |
PageSize | 否 | Integer | 页面大小 示例值:10000 |
Count | 否 | Integer | 数据总数 示例值:20 |
RequestBaseInfo | 否 | ProjectBaseInfoOpsRequest | 基础请求信息 |
IsCount | 否 | Boolean | 是否计算总数 示例值:true |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | CollectionInstanceOpsDto | 结果 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 拉取dag实例
拉取dag实例
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DagInstances
<公共请求参数>
{
"ProjectId": "1460947878944567296",
"PageIndex": 1,
"PageSize": 10000,
"SearchCondition": {
"Instance": {
"TaskId": "20230313145623119",
"CurRunDate": "2023-03-13 14:55:53"
},
"DagType": "1",
"DagDependent": "3",
"DagDepth": 1
}
}
输出示例
{
"Response": {
"Data": {
"Items": [
{
"InstanceKey": "20230313145623119_2023-03-13 14:55:53",
"AvgCostTime": null,
"CostMillisecond": null,
"CostTime": "00:00:00.000",
"CreateTime": "2023-03-13 14:57:01",
"CurRunDate": "2023-03-13 14:55:53",
"CycleType": "ONEOFF_CYCLE",
"DependenceFulfillTime": "2023-03-20 21:15:45",
"DependencyRel": null,
"DoFlag": 0,
"EndTime": "2023-03-20 21:16:00",
"ErrorDesc": "Dependency check failed at 2023-03-20T21:21:13.007+08:00 with reason: task 20230313145623119 's parent task instance failed: 20230313145539749 2023-03-13 14:55:53; parent instance failed num:1;relationShip:AND",
"ExecutionSpace": "CYCLIC",
"FirstDependenceFulfillTime": "2023-03-20 21:15:45",
"FirstRunTime": null,
"FirstStartTime": null,
"FirstSubmitTime": null,
"FolderId": null,
"FolderName": null,
"IgnoreEvent": true,
"InCharge": "stackxchen",
"LastLog": null,
"LastSchedulerDateTime": null,
"LastUpdate": "2023-03-20 21:21:14",
"MaxCostTime": null,
"MinCostTime": null,
"NextCurDate": "2023-03-13 14:55:53",
"ProductName": "DATA_DEV",
"ProjectId": "1460947878944567296",
"ProjectIdent": "us_dev",
"ProjectName": "调度dev验证项目",
"RedoFlag": 1,
"ResourceGroup": "20221229154930684210",
"ResourceInstanceId": "any",
"RunPriority": 6,
"RuntimeBroker": "ins-6m3r7n1h",
"SchedulerDateTime": "2023-03-13 14:55:53",
"SchedulerDesc": null,
"SonList": "[&&&\"TaskId\":\"20230313145539749\",\"TaskName\":\"parent_task\",\"WorkflowId\":\"d3398ce9-8743-11ed-8909-bc97e105ba60\",\"WorkflowName\":\"flow_01\",\"InCharge\":\"stackxchen\",\"CycleType\":\"ONEOFF_CYCLE\",\"CurRunDate\":\"2023-03-13 14:55:53\",\"NextCurDate\":\"2023-03-13 14:55:53\",\"RunPriority\":6,\"TryLimit\":5,\"Tries\":0,\"TotalRunNum\":0,\"DoFlag\":0,\"RedoFlag\":1,\"State\":\"EXPIRED\",\"RuntimeBroker\":\"ins-6m3r7n1h\",\"ErrorDesc\":\"\",\"TaskType\":&&&\"typeDesc\":\"Shell\",\"typeId\":35,\"typeSort\":\"数据计算\"},\"DependenceFulfillTime\":\"2023-03-20 21:18:51\",\"FirstDependenceFulfillTime\":\"2023-03-20 21:18:51\",\"StartTime\":\"2023-03-20 21:18:18\",\"EndTime\":\"2023-03-20 21:18:20\",\"CostTime\":\"00:00:02.000\",\"CostMillisecond\":2000,\"LastLog\":\"Had been kill\",\"SchedulerDateTime\":\"2023-03-13 14:55:53\",\"LastUpdate\":\"2023-03-20 21:19:02\",\"CreateTime\":\"2023-03-13 14:56:11\",\"ExecutionSpace\":\"CYCLIC\",\"IgnoreEvent\":true,\"VirtualFlag\":false,\"FolderId\":\"cc31c16e-8743-11ed-8909-bc97e105ba60\",\"FolderName\":\"stackxchen\",\"list\":[],\"ProductName\":\"DATA_DEV\",\"ResourceGroup\":\"20221229154930684210\",\"ResourceInstanceId\":\"any\",\"SchedulerDesc\":\"2023年03月13日 14:55:53执行\",\"ProjectIdent\":\"us_dev\",\"ProjectName\":\"调度dev验证项目\",\"TenantId\":\"1315051789\"}]",
"StartTime": null,
"State": "EVENT_LISTENING",
"TaskId": "20230313145623119",
"TaskName": "son_task",
"TaskType": {
"TypeDesc": "Shell",
"TypeId": 35,
"TypeSort": "数据计算"
},
"TenantId": "1315051789",
"TotalRunNum": 0,
"Tries": 0,
"TryLimit": 5,
"VirtualFlag": false,
"WorkflowId": "d3398ce9-8743-11ed-8909-bc97e105ba60",
"WorkflowName": "flow_01",
"YarnQueue": null
}
],
"PageCount": 0,
"PageNumber": 1,
"PageSize": 10000,
"TotalCount": 1,
"TotalPage": 0
},
"RequestId": "aee4481f-a666-4d70-bcb6-d8b579b46086"
}
}
示例2 获取当前实例的子实例
获取当前实例的子实例
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DagInstances
<公共请求参数>
{
"SearchCondition": {
"Instance": {
"TaskId": "20240307211633923",
"CurRunDate": "2024-04-12 00:00:00"
},
"DagType": "2",
"DagDependent": "3",
"DagDepth": 1
},
"ProjectId": "1492511691706699776",
"PageIndex": 1,
"PageSize": 10000
}
输出示例
{
"Response": {
"Data": {
"Items": [
{
"AvgCostTime": null,
"CostMillisecond": null,
"CostTime": "00:02:02.000",
"CreateTime": "2024-04-12 14:56:56",
"CurRunDate": "2024-04-12 00:00:00",
"CycleType": "CRONTAB_CYCLE",
"DependenceFulfillTime": "2024-04-12 14:56:56",
"DependencyRel": null,
"DoFlag": 1,
"EndTime": "2024-04-12 14:59:05",
"ErrorDesc": "",
"ExecutionSpace": "CYCLIC",
"ExecutorGroupId": null,
"ExecutorGroupName": null,
"FirstDependenceFulfillTime": "2024-04-12 14:56:56",
"FirstRunTime": null,
"FirstStartTime": "2024-04-12 14:57:03",
"FirstSubmitTime": null,
"FolderId": null,
"FolderName": null,
"IgnoreEvent": true,
"InCharge": "micofywang",
"InstanceKey": "20240307211633923_2024-04-12 00:00:00",
"InstanceLifeCycleOpsDto": null,
"LastLog": null,
"LastSchedulerDateTime": null,
"LastUpdate": "2024-04-12 14:59:07",
"MaxCostTime": null,
"MinCostTime": null,
"NextCurDate": "2024-04-13 00:00:00",
"OwnerId": "100028448903",
"ProductName": "DATA_DEV",
"ProjectId": "1492511691706699776",
"ProjectIdent": "Ryanrliao_DI",
"ProjectName": "集成",
"RedoFlag": 0,
"RelatedInstanceList": null,
"RelatedInstanceSize": 0,
"ResourceGroup": "20221229172428663695",
"ResourceInstanceId": "ins-g8j6pv4f",
"RetryAttempts": 0,
"RunPriority": 6,
"RuntimeBroker": "ins-g8j6pv4f",
"SchedulerDateTime": "2024-04-12 00:00:00",
"SchedulerDesc": null,
"SonList": "[&&&\"TaskId\":\"20240307211852581\",\"TaskName\":\"python_task_failed\",\"WorkflowId\":\"ca1253e8-dc84-11ee-8d13-a4ae120f8272\",\"WorkflowName\":\"mico_wf_test_alarm\",\"InCharge\":\"micofywang\",\"CycleType\":\"CRONTAB_CYCLE\",\"CurRunDate\":\"2024-04-12 00:00:00\",\"NextCurDate\":\"2024-04-13 00:00:00\",\"RunPriority\":6,\"TryLimit\":5,\"Tries\":3,\"TotalRunNum\":3,\"DoFlag\":1,\"RedoFlag\":0,\"State\":\"FAILED\",\"RuntimeBroker\":\"ins-g8j6pv4f\",\"ErrorDesc\":\"\",\"TaskType\":&&&\"TypeDesc\":\"Python\",\"TypeId\":30,\"TypeSort\":\"数据计算\"},\"DependenceFulfillTime\":\"2024-04-12 15:04:32\",\"FirstDependenceFulfillTime\":\"2024-04-12 14:50:09\",\"FirstStartTime\":\"2024-04-12 14:50:23\",\"StartTime\":\"2024-04-12 15:04:37\",\"EndTime\":\"2024-04-12 15:04:40\",\"CostTime\":\"00:00:03.000\",\"CostMillisecond\":3000,\"SchedulerDateTime\":\"2024-04-12 00:00:00\",\"LastUpdate\":\"2024-04-12 15:04:42\",\"CreateTime\":\"2024-04-12 14:50:09\",\"ExecutionSpace\":\"CYCLIC\",\"IgnoreEvent\":true,\"VirtualFlag\":false,\"FolderId\":\"9e954395-d479-11ee-8d13-a4ae120f8272\",\"FolderName\":\"micofywang\",\"list\":[],\"RelatedInstanceSize\":0,\"ProductName\":\"DATA_DEV\",\"ResourceGroup\":\"20221229172428663695\",\"ResourceInstanceId\":\"ins-g8j6pv4f\",\"ProjectId\":\"1492511691706699776\",\"ProjectIdent\":\"Ryanrliao_DI\",\"ProjectName\":\"集成\",\"TenantId\":\"1315051789\",\"OwnerId\":\"100028448903\",\"UserId\":\"100033435965\",\"InstanceKey\":\"20240307211852581_2024-04-12 00:00:00\",\"RetryAttempts\":0}]",
"StartTime": "2024-04-12 14:57:03",
"State": "COMPLETED",
"TaskId": "20240307211633923",
"TaskName": "shell_task_timeout_success",
"TaskType": {
"TypeDesc": "Shell",
"TypeId": 35,
"TypeSort": "数据计算"
},
"TenantId": "1315051789",
"TotalRunNum": 1,
"Tries": 1,
"TryLimit": 5,
"UserId": "100033435965",
"VirtualFlag": false,
"WorkflowId": "ca1253e8-dc84-11ee-8d13-a4ae120f8272",
"WorkflowName": "mico_wf_test_alarm",
"YarnQueue": null
}
],
"PageCount": 0,
"PageNumber": 1,
"PageSize": 10000,
"TotalCount": 1,
"TotalPage": 0
},
"RequestId": "b71bbdac-8001-4966-b183-a1e4bac8f903"
}
}
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 | 操作失败。 |