获取服务概览摘要数据

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

1. 接口描述

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

在HDFS组件的服务状态的服务摘要下，查询服务的摘要信息

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

接口更新时间：2024-11-01 11:26:48。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeInstanceServiceAbstract
Version 是 否 String 公共参数，本接口取值：2019-01-03
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId 是 否 String emr序列号，eg. emr-xxxxx
示例值： tbds-1vzudj86
ServiceName 是 否 String 服务名称，eg. HDFS/YARN等
示例值： ZOOKEEPER

3. 输出参数

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

4. 错误码

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

错误码 描述
InvalidParameter.InvalidClusterId 无效参数，ClusterId。
InternalError.OpenTSDBHttpReturnCodeNotOK 请求OpenTSDB失败。
ResourceNotFound.ClusterNotFound 无法找到该实例。
ResourceNotFound.HardwareInfoNotFound 无法找到硬件信息。

5. 示例

示例1 【监控】获取服务概览摘要数据

服务概览页面摘要数据获取

输入示例

https://emr.api3.{{conf.domain_main}}/?Action=DescribeInstanceServiceAbstract
&InstanceId=emr-3onyyp3p
&ServiceName=HDFS
&<公共请求参数>

输出示例

{
    "Response": {
        "ItemList": [
            {
                "Key": "NameNode HA状态",
                "Value": "172.30.1.146(主)  172.30.0.49(备)"
            },
            {
                "Key": "空间利用率",
                "Value": "1.4% 4G已用/277G总量"
            }
        ],
        "RequestId": "da857ac9-d6fb-425b-880f-a46479aa10cd"
    }
}