1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
查看事件实例的消费任务
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeEventConsumeTasks。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| EventCaseId | 是 | String | 事件实例ID 示例值："7b55e80c3a7949428c34b02ab82b09b7" |
| PageNumber | 是 | Integer | 页码 示例值：1 |
| PageSize | 是 | Integer | 每页数目 示例值：20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | EventCaseConsumeLogOptDtoCollection | 事件消费任务记录列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"Items":[],"PageCount":0,"PageNumber":1,"PageSize":20,"TotalCount":0,"TotalPage":0} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功获取事件实例消费任务
成功获取事件实例消费任务
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEventConsumeTasks
<公共请求参数>
{
"EventCaseId": "9e2a0e1f870ec340018712b3925f0006",
"PageNumber": 1,
"PageSize": 10
}输出示例
{
"Response": {
"Data": {
"Items": [
{
"ConsumeLogId": "9eb04578870ec50d018712b3938d0005",
"ConsumerDetail": {
"Submit": true,
"TasksStr": "",
"BrokerIp": "any",
"ClusterId": null,
"CreateTime": "2023-03-24 16:09:14",
"Creator": "stackxchen",
"Crontab": null,
"CrontabExpression": null,
"CycleNum": null,
"CycleStep": 5,
"CycleType": "MINUTE_CYCLE",
"CycleUnit": null,
"DelayTime": 0,
"DependencyRel": "and",
"DependencyWorkflow": "no",
"EndDate": null,
"EndTime": "2023-03-24 23:59:59",
"EventListenerConfig": null,
"EventPublisherConfig": null,
"ExecutionEndTime": null,
"ExecutionStartTime": null,
"ExecutionTTL": -1,
"FirstRunTime": null,
"FirstSubmitTime": null,
"FolderId": null,
"FolderName": null,
"InCharge": "stackxchen",
"InChargeId": "100028590605",
"InitStrategy": null,
"InstanceInitStrategy": "T_PLUS_0",
"LastSchedulerCommitTime": null,
"LastUpdate": "2023-03-24 16:18:31",
"Layer": null,
"LeftCoordinate": 376,
"MaxDateTime": null,
"MinDateTime": null,
"NormalizedJobStartTime": null,
"Notes": "",
"OwnId": "100028448903",
"ProductName": "DATA_DEV",
"ProjectId": "1460963739345731584",
"ProjectIdent": "us_pre",
"ProjectName": "调度预发验证项目",
"RealWorkflowId": null,
"ResourceGroup": "20221221143954438902",
"RetryAble": 1,
"RetryWait": 5,
"RunPriority": 6,
"ScheduleDesc": null,
"SchedulerDesc": "从2023年03月24日 00:00:00开始，每间隔5分钟执行一次",
"SelfDepend": "parallel",
"ShowWorkflow": false,
"SourceServiceId": null,
"SourceServiceType": null,
"StartDate": null,
"StartTime": "2023-03-24 00:00:00",
"StartupTime": 0,
"Status": "Y",
"TargetServiceId": null,
"TargetServiceType": null,
"TaskAction": "",
"TaskId": "20230324160914089",
"TaskLinkInfo": null,
"TaskName": "test_event_minute",
"TaskType": {
"TypeDesc": "Shell",
"TypeId": 35,
"TypeSort": "数据计算"
},
"TaskTypeDesc": null,
"TaskTypeId": null,
"TenantId": "1315051789",
"TopCoordinate": 247,
"TryLimit": 5,
"UpdateTime": "2023-03-24 16:18:29",
"UpdateUser": "stackxchen",
"UpdateUserId": "100028590605",
"UserId": "100028590605",
"VirtualFlag": false,
"VirtualTaskId": null,
"VirtualTaskStatus": null,
"WorkflowId": "68ce6df0-7b80-11ed-a3a7-b8cef6c14251",
"WorkflowName": "dev_test",
"YarnQueue": null
},
"ConsumerId": "20230324160914089",
"CreationTimestamp": "2023-03-24T08:19:31.340Z",
"EventCaseId": "9e2a0e1f870ec340018712b3925f0006"
}
],
"PageCount": 1,
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 1,
"TotalPage": 1
},
"RequestId": "b7d1e5cf-3454-48db-a261-41a760f70ee6"
}
}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 | 操作失败。 |