1. 接口描述
接口请求域名: tbdsnew.api3.fincloud.tencent.cn。
查询节点状态下部署状态基本信息和进程列表数据
默认接口请求频率限制:20次/秒。
接口更新时间:2024-11-01 12:41:03。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeEMRHostOverview |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-01-03 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 集群ID 示例值: tbds-1vzudj86 |
| Ip | 是 | 否 | String | 查询的主机Ip 示例值: 172.16.0.89 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| NormalProcessNum | Int64 | 正常部署运行的进程数 示例值: 1 |
| MissedProcessNum | Int64 | 缺失的进程数 示例值: 1 |
| IllegalProcessNum | Int64 | 非法进程数 示例值: 1 |
| MissedProcesses | Array of String | 缺失的进程 注意:此字段可能返回 null,表示取不到有效值。 示例值: 1 |
| IllegalProcesses | Array of String | 非法进程 注意:此字段可能返回 null,表示取不到有效值。 示例值: 1 |
| NormalProcesses | Array of String | 正常部署运行的进程 注意:此字段可能返回 null,表示取不到有效值。 示例值: 1 |
| SupportMonitorRoles | Array of SupportMonitorRole | 支持监控角色 注意:此字段可能返回 null,表示取不到有效值。 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound.ClusterNotFound | 无法找到该实例。 |
5. 示例
示例1 【监控】主机详情页查询进程状态
输入示例
POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeEMRHostOverview
<公共请求参数>
{
"InstanceId": "tbds-1vzudj86",
"Ip": "172.16.0.89"
}
输出示例
{
"Response": {
"IllegalProcessNum": 0,
"IllegalProcesses": [],
"MissedProcessNum": 0,
"MissedProcesses": [],
"NormalProcessNum": 18,
"NormalProcesses": [
"HMaster",
"HiveMetaStore",
"HiveServer2",
"HiveWebHcat",
"Hue",
"Impala-Catalog",
"Impala-Statestore",
"JournalNode",
"KafkaManager",
"Knox",
"KyuubiServer",
"NameNode",
"ResourceManager",
"SparkJobHistoryServer",
"ThriftServer",
"Trino-Coordinator",
"ZKFailoverController",
"Zookeeper"
],
"RequestId": "6ae06e89-83dc-47e6-afc0-bed989919736",
"SupportMonitorRoles": [
{
"ProcessName": "HiveWebHcat",
"ProcessNodeType": 32,
"ServiceName": "HIVE",
"IsSupportMonitor": true
},
{
"ProcessName": "JournalNode",
"ProcessNodeType": 3,
"ServiceName": "HDFS",
"IsSupportMonitor": true
},
{
"ProcessName": "KafkaManager",
"ProcessNodeType": 77,
"ServiceName": "KAFKA",
"IsSupportMonitor": true
},
{
"ProcessName": "KyuubiServer",
"ProcessNodeType": 87,
"ServiceName": "KYUUBI",
"IsSupportMonitor": true
},
{
"ProcessName": "ZKFailoverController",
"ProcessNodeType": 8,
"ServiceName": "HDFS",
"IsSupportMonitor": true
},
{
"ProcessName": "HiveMetaStore",
"ProcessNodeType": 30,
"ServiceName": "HIVE",
"IsSupportMonitor": true
},
{
"ProcessName": "HiveServer2",
"ProcessNodeType": 31,
"ServiceName": "HIVE",
"IsSupportMonitor": true
},
{
"ProcessName": "HMaster",
"ProcessNodeType": 4,
"ServiceName": "HBASE",
"IsSupportMonitor": true
},
{
"ProcessName": "Impala-Catalog",
"ProcessNodeType": 49,
"ServiceName": "IMPALA",
"IsSupportMonitor": true
},
{
"ProcessName": "NameNode",
"ProcessNodeType": 1,
"ServiceName": "HDFS",
"IsSupportMonitor": true
},
{
"ProcessName": "Trino-Coordinator",
"ProcessNodeType": 90,
"ServiceName": "TRINO",
"IsSupportMonitor": true
},
{
"ProcessName": "Knox",
"ProcessNodeType": 50,
"ServiceName": "KNOX",
"IsSupportMonitor": false
},
{
"ProcessName": "ThriftServer",
"ProcessNodeType": 37,
"ServiceName": "HBASE",
"IsSupportMonitor": false
},
{
"ProcessName": "Hue",
"ProcessNodeType": 15,
"ServiceName": "HUE",
"IsSupportMonitor": false
},
{
"ProcessName": "Zookeeper",
"ProcessNodeType": 0,
"ServiceName": "ZOOKEEPER",
"IsSupportMonitor": true
},
{
"ProcessName": "SparkJobHistoryServer",
"ProcessNodeType": 17,
"ServiceName": "SPARK",
"IsSupportMonitor": true
},
{
"ProcessName": "Impala-Statestore",
"ProcessNodeType": 48,
"ServiceName": "IMPALA",
"IsSupportMonitor": true
},
{
"ProcessName": "ResourceManager",
"ProcessNodeType": 6,
"ServiceName": "YARN",
"IsSupportMonitor": true
}
]
}
}