租户端 大数据 大数据处理套件(TBDS) 信息查询相关接口 查询资源分析统计列表中的每列的表头字段信息

查询资源分析统计列表中的每列的表头字段信息

最近更新时间: 2026-09-17 00:05:45

1. 接口描述

接口请求域名: tbdsnew.api3.fincloud.tencent.cn。

查询资源分析统计列表中的每列的表头字段信息,比如Yarn作业列表表头、impala查询列表表头等

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

接口更新时间:2024-11-01 12:03:13。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeDynamicTableMeta
Version String 公共参数,本接口取值:2019-01-03
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId String 集群Id
示例值: tbds-1vzudj86
Category String 类别,如 yarn, impala ...
示例值: yarn
StartTime Int64 起始时间
示例值: 1748188800
EndTime Int64 结束时间
示例值: 1748251549

3. 输出参数

参数名称 类型 描述
Columns Array of ColumnInfo 列元数据信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:查看
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameter.ImpalaQueryException impala查询参数异常。
InternalError.DBQueryException DB查询异常。
ResourceNotFound 资源不存在。

5. 示例

示例1 【监控】获取动态列元数据

输入示例

https://emr.api3.{{conf.domain_main}}/?Action=DescribeDynamicTableMeta
&InstanceId=emr-9kd5tnmq
&Category=yarn
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "xx", 
        "Columns": [
            {
                "ColumnId": "xx", 
                "Width": 0, 
                "IsShow": 0, 
                "FilterList": [
                    "xx"
                ], 
                "ColumnName": "xx", 
                "ColumnNameCn": "xx", 
                "Action": 0, 
                "ColumnNameEn": "xx"
            }, 
            {
                "ColumnId": "xx", 
                "ColumnName": "xx", 
                "IsShow": 1, 
                "FilterList": [
                    "xx"
                ], 
                "Width": 0, 
                "ColumnNameCn": "xx", 
                "Action": 2, 
                "ColumnNameEn": "xx"
            }, 
            {
                "ColumnId": "xx", 
                "ColumnName": "xx", 
                "IsShow": 1, 
                "FilterList": [
                    "xx"
                ], 
                "Width": 0, 
                "ColumnNameCn": "xx", 
                "Action": 1, 
                "ColumnNameEn": "xx"
            }, 
            {
                "ColumnId": "xx", 
                "ColumnName": "xx", 
                "IsShow": 0, 
                "FilterList": [
                    "xx"
                ], 
                "Width": 0, 
                "ColumnNameCn": "xx", 
                "Action": 0, 
                "ColumnNameEn": "xx"
            }
        ]
    }
}