查询实时任务表粒度指标概览

最近更新时间:2025-01-17 01:30:55

我的收藏

1. 接口描述

接口请求域名: wedata.tencentcloudapi.com 。

查询实时任务表粒度指标概览

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTaskTableMetricOverview。
Version String 公共参数,本接口取值:2021-08-20。
Region String 公共参数,详见产品支持的 地域列表
TaskId String 任务TaskId
示例值:"123"
NodeType String 来源类型,支持枚举: SOURCE、SINK
示例值:"SOURCE"
PageNumber Integer 页码
示例值:1
PageSize Integer 页大小
示例值:10
ProjectId String 项目ID
示例值:"1"
TaskType Integer 任务类型:201. stream, 202. offline,当前只支持实时201
示例值:201
Filters.N Array of Filter 根据SchemaName来模糊搜索
OrderFields.N Array of OrderFields 排序

3. 输出参数

参数名称 类型 描述
TaskTableMetricInfos Array of TaskTableMetricInfo 表粒度指标集合
TotalCount Integer 总数
示例值:1
MetricType String 返回列表类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:"num"
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实时任务表粒度指标概览

输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskTableMetricOverview
<公共请求参数>

{
    "TaskId": "123",
    "NodeType": "NodeType",
    "TaskType": 0,
    "Filters": [
        {
            "Name": "Name",
            "Values": [
                "1"
            ]
        }
    ],
    "PageNumber": 0,
    "PageSize": 0,
    "OrderFields": [
        {
            "Name": "Name",
            "Direction": "Direction"
        }
    ],
    "ProjectId": "1"
}

输出示例

{
    "Response": {
        "TaskTableMetricInfos": [
            {
                "DatabaseName": "DatabaseName",
                "TableName": "TableName",
                "TotalRecordNum": 0,
                "TotalRecordByteNum": 0,
                "TotalDirtyRecordNum": 0,
                "SchemaName": "SchemaName",
                "Topic": "Topic",
                "Collection": "Collection",
                "DataSourceName": "DataSourceName",
                "NodeId": "123"
            }
        ],
        "TotalCount": 0,
        "MetricType": "num",
        "RequestId": "as1cs2c123asyi23bh213cc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
UnsupportedOperation 操作不支持。