获取服务角色表数据

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

1. 接口描述

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

在服务组件的角色管理下，点击角色名进入到角色详情页面，拉取服务概览页每个组件下每个角色的基本信息

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

接口更新时间：2024-12-07 03:24:34。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeInstanceServiceRoleTable
Version	是	否	String	公共参数，本接口取值：2019-01-03
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId	是	否	String	emr集群序列号，eg. emr-xxxx 示例值： tbds-1vzudj86
ServiceName	是	否	String	服务组件名称，eg. HDFS/YARN/... 示例值： HDFS
Namespace	是	否	String	服务角色名称，eg. DataNode/NameNode 示例值： NameNode
Offset	否	否	Int64	偏移量，从0开始，表示第一页示例值： 0
Limit	否	否	Int64	每页数目，默认为10，最小值为1，表示至少加载一条数据示例值： 10
Filters	否	否	Array of InstanceServiceRoleTableFilterItem	要过滤的字段名称和取值的数组示例值：查看
OrderField	否	否	String	保留字段，当前版本暂未支持示例值： 1
OrderType	否	否	String	保留字段，当前版本暂未支持示例值： 1
HostIp	否	否	String	根据ip地址过滤示例值： None

3. 输出参数

参数名称	类型	描述
TotalCount	Int64	总的记录数示例值： 1
Contents	Array of ServiceMetricRoleTableItem	表格数据，string[]数组的列表注意：此字段可能返回 null，表示取不到有效值。示例值：查看
SchemaList	Array of TableSchemaItem	表头数据注意：此字段可能返回 null，表示取不到有效值。示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameter.InvalidClusterId	无效参数，ClusterId。
ResourceNotFound.ClusterNotFound	无法找到该实例。

5. 示例

示例1 【监控】获取服务角色表数据

服务概览页每个组件下每个角色的数据

输入示例

https://emr.api3.{{conf.domain_main}}/?Action=DescribeInstanceServiceRoleTable
&InstanceId=emr-d1q97bhv
&ServiceName=HDFS
&Namespace=NameNode
&<公共请求参数>

输出示例

{
    "Response": {
        "Content": [
            {
                "Row": [
                    "NameNode",
                    "Master",
                    "172.30.0.49",
                    "运行中",
                    "堆内存已使用 674.06M 堆内存总计  4096.00M"
                ]
            },
            {
                "Row": [
                    "NameNode",
                    "Master",
                    "172.30.1.146",
                    "运行中",
                    "堆内存已使用 2427.30M 堆内存总计  4096.00M"
                ]
            }
        ],
        "RequestId": "99c79acf-c720-4093-bdf4-db96fcf785d6",
        "Schema": [
            {
                "Name": "角色",
                "Sortable": false,
                "WithFilter": false,
                "Candidates": null
            },
            {
                "Name": "节点类型",
                "Sortable": false,
                "WithFilter": true,
                "Candidates": [
                    "Core",
                    "Master",
                    "Router",
                    "Task"
                ]
            },
            {
                "Name": "节点IP",
                "Sortable": false,
                "WithFilter": false,
                "Candidates": null
            },
            {
                "Name": "服务状态",
                "Sortable": false,
                "WithFilter": true,
                "Candidates": [
                    "已停止",
                    "运行中"
                ]
            },
            {
                "Name": "JVM内存情况",
                "Sortable": false,
                "WithFilter": false,
                "Candidates": null
            }
        ],
        "Total": 2
    }
}