1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
数据集成大屏概览
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeIntegrationStatistics。 |
| Version | 是 | String | 公共参数,本接口取值:2021-08-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| TaskType | 是 | Integer | 任务类型(实时:201,离线:202) 示例值:201 |
| ProjectId | 是 | String | 项目id 示例值:1 |
| QueryDate | 否 | String | 查询日期 示例值:2022-01-01 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalTask | Integer | 总任务数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| ProdTask | Integer | 生产态任务数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| DevTask | Integer | 开发态任务数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| TotalReadRecords | Integer | 总读取条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| TotalWriteRecords | Integer | 总写入条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| TotalErrorRecords | Integer | 总脏数据条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| TotalAlarmEvent | Integer | 总告警事件数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| IncreaseReadRecords | Integer | 当天读取增长条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| IncreaseWriteRecords | Integer | 当天写入增长条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| IncreaseErrorRecords | Integer | 当天脏数据增长条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| IncreaseAlarmEvent | Integer | 当天告警事件增长数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| AlarmEvent | String | 告警事件统计 注意:此字段可能返回 null,表示取不到有效值。 示例值:"{"important":1,"ordinary":0,"urgent":0}" |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeIntegrationStatistics
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIntegrationStatistics
<公共请求参数>
{
"QueryDate": "2022-01-01",
"TaskType": 201,
"ProjectId": "1"
}
输出示例
{
"Response": {
"TotalTask": 0,
"ProdTask": 0,
"DevTask": 0,
"TotalReadRecords": 0,
"TotalWriteRecords": 0,
"TotalErrorRecords": 0,
"TotalAlarmEvent": 0,
"IncreaseReadRecords": 0,
"IncreaseWriteRecords": 0,
"IncreaseErrorRecords": 0,
"IncreaseAlarmEvent": 0,
"AlarmEvent": "{\"important\":1,\"ordinary\":0,\"urgent\":0}",
"RequestId": "as1cs2c123asyi23bh213cc"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |