1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
实时任务运行指标概览
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRealTimeTaskMetricOverview。 |
Version | 是 | String | 公共参数,本接口取值:2021-08-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TaskId | 是 | String | 要查看的实时任务的任务ID,可在任务列表页面中获得 示例值:n5dc548fd-53cc-4282-0123-c56f50c447b9 |
ProjectId | 是 | String | 要查看的项目ID 示例值:1786529890123752960 |
StartTime | 否 | Integer | 开始时间 示例值:1669693200000 |
EndTime | 否 | Integer | 结束时间 示例值:1669693200000 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalRecordNumOfRead | Integer | 总读取记录数 示例值:91171 |
TotalRecordByteNumOfRead | Integer | 总读取字节数 示例值:91171 |
TotalRecordNumOfWrite | Integer | 总写入记录数 示例值:91171 |
TotalRecordByteNumOfWrite | Integer | 总写入字节数 单位字节 示例值:1911271 |
TotalDirtyRecordNum | Integer | 总的脏记录数据 示例值:91171 |
TotalDirtyRecordByte | Integer | 总的脏字节数 单位字节 示例值:1291171 |
TotalDuration | Integer | 运行时长 单位s 示例值:91171 |
BeginRunTime | String | 开始运行时间 示例值:2022-04-10 16:27:09 |
EndRunTime | String | 目前运行到的时间 示例值:2022-04-11 17:46:40 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 实时任务运行指标概览
实时任务运行指标概览
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRealTimeTaskMetricOverview
<公共请求参数>
{
"ProjectId": "1486446569620893696",
"TaskId": "j224b9321-3be0-45de-ad6a-8fed924036a4",
"StartTime": 1669693200000,
"EndTime": 1669693200000
}
输出示例
{
"Response": {
"TotalRecordNumOfRead": 91171,
"TotalRecordByteNumOfRead": 91171,
"TotalRecordNumOfWrite": 91171,
"TotalRecordByteNumOfWrite": 191171,
"TotalDirtyRecordNum": 91171,
"TotalDirtyRecordByte": 91171,
"TotalDuration": 191171,
"BeginRunTime": "2022-04-10 16:27:09",
"EndRunTime": "2022-04-11 17:46:40",
"RequestId": "55c2c097-26da-4302-b0dc-fc22bd33b54d"
}
}
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 | 操作失败。 |