获取某组件某角色下所有可视化曲线的元数据

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

1. 接口描述

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

获取某组件某角色下所有可视化曲线的元数据，比如x轴和y轴的名称等

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

接口更新时间：2024-11-28 11:34:54。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeEmrMetricMeta
Version	是	否	String	公共参数，本接口取值：2019-01-03
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId	是	否	String	集群实例ID， eg. emr-xxxx 示例值： tbds-1vzudj86
Services	否	否	Array of String	表示要查询的服务名称，不传递时默认查询全部；eg. ["HDFS", "YARN"], 示例值： 1
ServiceName	否	否	String	查询某个服务的名称， eg. "HDFS"/"YARN"/"NODE" 示例值： 1
NamespaceName	否	否	String	查询某个服务的某个namespace的元数据，eg. ”Overview"/"DataNode"/"NameNode" 示例值： 1
MetricNames	否	否	Array of String	查询的指标列表 [ "YARN.RM.QUEUE.VCORES", "YARN.RM.QUEUE.MEM" ] 示例值： 1

3. 输出参数

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

4. 错误码

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

错误码	描述
ResourceNotFound.MetricsMetaNotFound	无法找到监控元数据。
UnauthorizedOperation.AppIdMismatched	appid不一致。
ResourceNotFound.InstanceNotFound	无法找到该实例。
ResourceNotFound.ClusterNotFound	无法找到该实例。
ResourceNotFound	资源不存在。
InternalError	内部错误。

5. 示例

示例1 获取HBase region指标

输入示例

https://emr.api3.{{conf.domain_main}}/?Action=DescribeEmrMetricMeta
&InstanceId=emr-111df6u6
&ServiceName=HBASEREGION
&<公共请求参数>

输出示例

{
    "Response": {
        "MetaList": [
            {
                "ServiceName": "HBASEREGION",
                "Namespace": [
                    {
                        "Name": "RegionServer",
                        "Groups": [
                            {
                                "Title": "Table",
                                "MetricMetas": [
                                    {
                                        "Name": "HBASE.REGION.STAT",
                                        "Unit": "个/s",
                                        "Desc": "请求量",
                                        "Tags": [
                                            {
                                                "TagName": "ReadRequestCount",
                                                "TagInfo": "读请求量/s",
                                                "StatisticalMethod": "数据来源HBase UI，计算统计周期内的每秒增量"
                                            },
                                            {
                                                "TagName": "WriteRequestCount",
                                                "TagInfo": "写请求量/s",
                                                "StatisticalMethod": "数据来源HBase UI，计算统计周期内的每秒增量"
                                            }
                                        ],
                                        "Selected": true
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ],
        "RequestId": "c9ec51ed-79c2-4f47-89ec-2054f16e73d5"
    }
}