获取集群主机信息
最近更新时间: 2026-09-17 00:05:46
1. 接口描述
接口请求域名： tbdsnew.api3.fincloud.tencent.cn。
在集群资源的节点状态下，节点列表下获取集群的节点信息，包括节点类型及其CPU和内存利用率等
默认接口请求频率限制：20次/秒。
接口更新时间：2024-12-06 06:26:10。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeInstanceNodes |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-01-03 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 集群名 示例值： tbds-1vzudj86 |
| Host | 否 | 否 | String | ip， 当根据ip查询时传入 示例值： |
| EmrNodeType | 否 | 否 | String | 节点类型，当根据节点类型查询时传入 master\core等 示例值： |
| Offset | 否 | 否 | Int64 | 分页页号，默认值为0，表示第一页 示例值： 0 |
| Limit | 否 | 否 | Int64 | 每页容量，默认值为10，最大值为100 示例值： 10 |
| Sort | 否 | 否 | String | 排序方向，不传则不排序 取值有desc和asc 示例值： |
| SortBy | 否 | 否 | String | 根据那个字段来排序，取值有cpu、memory、disk 示例值： |
| AgentStatus | 否 | 否 | Int64 | agent状态，-1:离线，1:在线 ，不筛选前端可不传默认是0 示例值： -99 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Offset | Int64 | 页号 示例值： 1 |
| TotalPage | Int64 | 总页数 示例值： 1 |
| ChosenItemNum | Int64 | 已选数量 示例值： 1 |
| TotalCount | Int64 | 总数量 示例值： 1 |
| InstanceNodeList | Array of InstanceNodeItem | 节点描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：查看 |
| EmrNodeTypes | Array of String | EMR节点类型数组 注意：此字段可能返回 null，表示取不到有效值。 示例值： 1 |
| AliasInfo | String | 别名数组信息，base64编码 示例值： 1 |
| AgentStatusFilter | Array of Int64 | 状态筛选列表 注意：此字段可能返回 null，表示取不到有效值。 示例值： 1 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.InvalidClusterId | 无效参数，ClusterId。 |
| ResourceNotFound.ClusterNotFound | 无法找到该实例。 |
5. 示例
示例1 【监控218】获取集群主机信息
输入示例
POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeInstanceNodes
<公共请求参数>
{
"InstanceId": "tbds-1vzudj86",
"Host": "",
"EmrNodeType": "",
"Offset": 0,
"Limit": 10,
"AgentStatus": -99,
"Sort": "",
"SortBy": ""
}
输出示例
{
"Response": {
"AgentStatusFilter": [
1,
-1
],
"AliasInfo": "eyJjb3JlIjoiY29yZSIsIm1hc3RlciI6Im1hc3RlciIsInRhc2siOiJ0YXNrIn0=",
"ChosenItemNum": 8,
"EmrNodeTypes": [
"MASTER",
"CORE"
],
"InstanceNodeList": [
{
"Host": "172.16.0.89",
"HostName": "tbds-172-16-0-89",
"EmrNodeType": "MASTER",
"CpuUsedRatio": 0.79,
"MemoryUsedRatio": 0.46,
"DiskUsedRatio": 0.083,
"AgentStatus": 1,
"LastHeartbeat": "2025-05-26 17:46:13"
},
{
"Host": "172.16.0.55",
"HostName": "tbds-172-16-0-55",
"EmrNodeType": "MASTER",
"CpuUsedRatio": 0.795,
"MemoryUsedRatio": 0.457,
"DiskUsedRatio": 0.058,
"AgentStatus": 1,
"LastHeartbeat": "2025-05-26 17:46:13"
},
{
"Host": "172.16.0.71",
"HostName": "tbds-172-16-0-71",
"EmrNodeType": "MASTER",
"CpuUsedRatio": 0.497,
"MemoryUsedRatio": 0.313,
"DiskUsedRatio": 0.05,
"AgentStatus": 1,
"LastHeartbeat": "2025-05-26 17:46:13"
},
{
"Host": "172.16.0.117",
"HostName": "tbds-172-16-0-117",
"EmrNodeType": "CORE",
"CpuUsedRatio": 0.359,
"MemoryUsedRatio": 0.233,
"DiskUsedRatio": 0.623,
"AgentStatus": 1,
"LastHeartbeat": "2025-05-26 17:46:14"
},
{
"Host": "172.16.0.121",
"HostName": "tbds-172-16-0-121",
"EmrNodeType": "CORE",
"CpuUsedRatio": 0.365,
"MemoryUsedRatio": 0.214,
"DiskUsedRatio": 0.44,
"AgentStatus": 1,
"LastHeartbeat": "2025-05-26 17:46:13"
},
{
"Host": "172.16.0.44",
"HostName": "tbds-172-16-0-44",
"EmrNodeType": "CORE",
"CpuUsedRatio": 0.353,
"MemoryUsedRatio": 0.197,
"DiskUsedRatio": 0.439,
"AgentStatus": 1,
"LastHeartbeat": "2025-05-26 17:46:13"
},
{
"Host": "172.16.0.109",
"HostName": "tbds-172-16-0-109",
"EmrNodeType": "CORE",
"CpuUsedRatio": 0.326,
"MemoryUsedRatio": 0.193,
"DiskUsedRatio": 0.439,
"AgentStatus": 1,
"LastHeartbeat": "2025-05-26 17:46:13"
},
{
"Host": "172.16.0.112",
"HostName": "tbds-172-16-0-112",
"EmrNodeType": "CORE",
"CpuUsedRatio": 0.38,
"MemoryUsedRatio": 0.22,
"DiskUsedRatio": 0.439,
"AgentStatus": 1,
"LastHeartbeat": "2025-05-26 17:46:13"
}
],
"Offset": 0,
"RequestId": "de5fe2da-edb1-432b-9cc3-7a27fd2981d4",
"TotalCount": 8,
"TotalPage": 1
}
}