查询集群节点信息
最近更新时间: 2026-09-17 00:05:51
1. 接口描述
接口请求域名： tbdsnew.api3.fincloud.tencent.cn。
查询集群节点信息
默认接口请求频率限制：20次/秒。
接口更新时间：2025-07-17 03:48:16。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeClusterNodes |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-01-03 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 集群实例ID,实例ID形如: emr-xxxxxxxx 示例值： tbds-664nmwbe |
| NodeFlag | 是 | 否 | String | 节点标识，取值为： 示例值： all |
| Offset | 否 | 否 | Int64 | 页编号，默认值为0，表示第一页。 示例值： 0 |
| Limit | 否 | 否 | Int64 | 每页返回数量，默认值为20，最大值为100。 示例值： 20 |
| HardwareResourceType | 否 | 否 | String | 资源类型:支持all/host/pod，默认为all 示例值： all |
| SearchFields | 否 | 否 | Array of SearchItem | 支持搜索的字段ip 示例值：查看 |
| OrderField | 否 | 否 | String | 创建时间ApplyTime 示例值： ApplyTime |
| Asc | 否 | 否 | Int64 | 1正序 0倒序 示例值： 1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCnt | Int64 | 查询到的节点总数 示例值： 1 |
| NodeList | Array of NodeHardwareInfo | 节点详细信息列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：查看 |
| TagKeys | Array of String | 用户所有的标签键列表 注意：此字段可能返回 null，表示取不到有效值。 示例值： 1 |
| HardwareResourceTypeList | Array of String | 资源类型列表 注意：此字段可能返回 null，表示取不到有效值。 示例值： 1 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.CbsCgwError | 内部服务调用异常。 |
| InternalError.CvmError | 内部服务调用异常。 |
| FailedOperation.GetCamServerFailed | 调用cam服务失败。 |
| InternalError.CdbCgwError | 内部服务调用异常。 |
| InvalidParameter.InvalidAppId | 无效参数，AppId。 |
| InternalError.WoodServerError | 内部服务调用异常。 |
| InvalidParameter.InvalidInstanceName | 无效的集群名称。 |
| InternalError.ProjectCgwError | 内部服务调用异常。 |
| InternalError.TradeCgwError | 内部服务调用异常。 |
| InternalError.AccountCgwError | 内部服务调用异常。 |
| FailedOperation.GetCamRoleFailed | 获取cam角色失败。 |
| InternalError | 内部错误。 |
| InternalError.VpcError | 内部服务调用异常。 |
| InternalError.KmsError | 内部服务调用异常。 |
| InvalidParameter.InvalidNodeType | 无效的NodeType。 |
| InternalError.VpcCgwError | 内部服务调用异常。 |
| UnsupportedOperation | 操作不支持。 |
| UnauthorizedOperation.CheckCamAuth | 校验账号操作无权限。 |
| InternalError.ConfigCgwError | 内部服务调用异常。 |
| InternalError.CbsError | 内部服务调用异常。 |
| InternalError.SgError | 安全组接口调用异常。 |
| ResourceNotFound.ClusterNotFound | 无法找到该实例。 |
| InternalError.CdbError | 内部服务调用异常。 |
| InternalError.TagError | 内部服务调用异常。 |
| InternalError.CamError | 内部服务调用异常。 |
| InternalError.CamCgwError | 内部服务调用异常。 |
| ResourceNotFound.InstanceNotFound | 无法找到该实例。 |
| FailedOperation | 操作失败。 |
5. 示例
示例1 查询集群节点信息
输入示例
POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeClusterNodes
<公共请求参数>
{
"InstanceId": "tbds-664nmwbe",
"NodeFlag": "all",
"Offset": 0,
"Limit": 20,
"HardwareResourceType": "all",
"SearchFields": [],
"OrderField": "ApplyTime",
"Asc": 1
}
输出示例
{
"Response": {
"HardwareResourceTypeList": [
"HOST"
],
"NodeList": [
{
"AppId": 1255000002,
"ApplyTime": "2025-05-17 15:27:47",
"Arch": "aarch64",
"AutoFlag": 0,
"CdbIp": "",
"CdbNodeInfo": null,
"CdbPort": 0,
"ChargeType": 0,
"Clients": "HDFS,ZOOKEEPER,KNOX,RANGER,OPENLDAP,YARN,HIVE,TRINO,FILEBEAT,KRB5,SPARK,KYUUBI,HBASE,FLINK,KAFKA,HUDI,AMORO,IMPALA,TEZ,HUE",
"CpuNum": 32,
"CurrentTime": "2025-05-26 19:36:13",
"Destroyable": 0,
"DeviceClass": "Unknown: ",
"DeviceName": "",
"DisableApiTermination": false,
"DiskSize": "9.77 GB",
"DynamicPodSpec": "",
"EmrResourceId": "tbds-qqknraokef",
"ExpireTime": "2025-05-17 23:27:47",
"FaultType": [],
"Flag": 1,
"FreeTime": "2025-05-17 23:27:47",
"HardwareResourceType": "HOST",
"HostName": "tbds-10-4-2-120",
"HwDiskSize": 10485760000,
"HwDiskSizeDesc": "9.77 GB",
"HwMemSize": 67186589696,
"HwMemSizeDesc": "62.57 GB",
"InstanceId": "",
"Ip": "10.4.2.120",
"Ipv6": "",
"IsAutoRenew": 0,
"IsDynamicSpec": 0,
"IsFederation": 0,
"MCMultiDisk": [
{
"Count": 1,
"Path": "/",
"Type": 16,
"Volume": 214747299328
},
{
"Count": 1,
"Path": "/data",
"Type": 16,
"Volume": 536870912000
}
],
"MachineType": "s29",
"MemDesc": "62.57 GB",
"MemSize": 67186589696,
"Mutable": 1,
"NameTag": "master.1,core.1",
"OrderNo": "tbds-qqknraokef",
"Rack": "/rack1",
"RegionId": 1,
"RoleExtTag": "{\"master\":[\"nnmaster\",\"rmmaster\"]}",
"RootSize": 0,
"RootStorageType": 0,
"SerialNo": "d67de2ed-2f22-407f-87cf-75d76e2d3039",
"ServiceClient": "",
"Services": "AmoroServer,DataNode,Filebeat,Gateway,HbaseThrift,HiveMetaStore,HiveServer2,HiveWebHcat,HMaster,RegionServer,HttpFS,Hue,Impala-Catalog,Impala-Coordinator,Impala-Executor,Impala-Statestore,JournalNode,Kafka,KafkaManager,KyuubiServer,NameNode,NodeManager,Zookeeper,ResourceManager,SparkJobHistoryServer,Tomcat,Trino-Coordinator,ZKFailoverController",
"Spec": "",
"StorageType": 0,
"SubnetInfo": {
"SubnetId": "",
"SubnetName": ""
},
"SupportModifyPayMode": 0,
"SupportRepairDisk": 0,
"Tags": [],
"TradeVersion": 0,
"WanIp": "10.4.2.120",
"Zone": "",
"ZoneId": 0
},
{
"AppId": 1255000002,
"ApplyTime": "2025-05-17 15:27:47",
"Arch": "aarch64",
"AutoFlag": 0,
"CdbIp": "",
"CdbNodeInfo": null,
"CdbPort": 0,
"ChargeType": 0,
"Clients": "HDFS,ZOOKEEPER,KNOX,RANGER,OPENLDAP,YARN,HIVE,TRINO,FILEBEAT,KRB5,SPARK,KYUUBI,HBASE,FLINK,KAFKA,HUDI,AMORO,IMPALA,TEZ,HUE",
"CpuNum": 32,
"CurrentTime": "2025-05-26 19:36:13",
"Destroyable": 0,
"DeviceClass": "Unknown: ",
"DeviceName": "",
"DisableApiTermination": false,
"DiskSize": "9.77 GB",
"DynamicPodSpec": "",
"EmrResourceId": "tbds-lauqr9hvnz",
"ExpireTime": "2025-05-17 23:27:47",
"FaultType": [],
"Flag": 1,
"FreeTime": "2025-05-17 23:27:47",
"HardwareResourceType": "HOST",
"HostName": "tbds-10-4-2-13",
"HwDiskSize": 10485760000,
"HwDiskSizeDesc": "9.77 GB",
"HwMemSize": 67186589696,
"HwMemSizeDesc": "62.57 GB",
"InstanceId": "",
"Ip": "10.4.2.13",
"Ipv6": "",
"IsAutoRenew": 0,
"IsDynamicSpec": 0,
"IsFederation": 0,
"MCMultiDisk": [
{
"Count": 1,
"Path": "/",
"Type": 16,
"Volume": 214747299328
},
{
"Count": 1,
"Path": "/data",
"Type": 16,
"Volume": 536870912000
}
],
"MachineType": "v23",
"MemDesc": "62.57 GB",
"MemSize": 67186589696,
"Mutable": 1,
"NameTag": "master.2,core.2",
"OrderNo": "tbds-lauqr9hvnz",
"Rack": "/rack1",
"RegionId": 1,
"RoleExtTag": "{\"master\":[\"nnmaster\",\"rmmaster\"]}",
"RootSize": 0,
"RootStorageType": 0,
"SerialNo": "d6ce9922-8724-4509-9eba-cad8e3fe7a4a",
"ServiceClient": "",
"Services": "AmoroServer,DataNode,Filebeat,Gateway,HbaseThrift,HiveMetaStore,HiveServer2,HiveWebHcat,HMaster,RegionServer,HttpFS,Hue,Impala-Catalog,Impala-Coordinator,Impala-Executor,Impala-Statestore,JournalNode,Kafka,KafkaManager,KyuubiServer,NameNode,NodeManager,Zookeeper,ResourceManager,SparkJobHistoryServer,Tomcat,Trino-Coordinator,ZKFailoverController",
"Spec": "",
"StorageType": 0,
"SubnetInfo": {
"SubnetId": "",
"SubnetName": ""
},
"SupportModifyPayMode": 0,
"SupportRepairDisk": 0,
"Tags": [
{
"TagKey": "auto_custom_tag_2755885376",
"TagValue": "auto_custom_tag_v_441958118"
}
],
"TradeVersion": 0,
"WanIp": "",
"Zone": "",
"ZoneId": 0
},
{
"AppId": 1255000002,
"ApplyTime": "2025-05-17 15:27:47",
"Arch": "aarch64",
"AutoFlag": 0,
"CdbIp": "",
"CdbNodeInfo": null,
"CdbPort": 0,
"ChargeType": 0,
"Clients": "HDFS,ZOOKEEPER,KNOX,RANGER,OPENLDAP,YARN,HIVE,TRINO,FILEBEAT,KRB5,SPARK,KYUUBI,HBASE,FLINK,KAFKA,HUDI,AMORO,IMPALA,TEZ,HUE",
"CpuNum": 32,
"CurrentTime": "2025-05-26 19:36:13",
"Destroyable": 0,
"DeviceClass": "Unknown: ",
"DeviceName": "",
"DisableApiTermination": false,
"DiskSize": "9.77 GB",
"DynamicPodSpec": "",
"EmrResourceId": "tbds-ohizdx8t80",
"ExpireTime": "2025-05-17 23:27:47",
"FaultType": [],
"Flag": 1,
"FreeTime": "2025-05-17 23:27:47",
"HardwareResourceType": "HOST",
"HostName": "tbds-10-4-2-93",
"HwDiskSize": 10485760000,
"HwDiskSizeDesc": "9.77 GB",
"HwMemSize": 67186589696,
"HwMemSizeDesc": "62.57 GB",
"InstanceId": "",
"Ip": "10.4.2.93",
"Ipv6": "",
"IsAutoRenew": 0,
"IsDynamicSpec": 0,
"IsFederation": 0,
"MCMultiDisk": [
{
"Count": 1,
"Path": "/",
"Type": 16,
"Volume": 214747299328
},
{
"Count": 1,
"Path": "/data",
"Type": 16,
"Volume": 536870912000
},
{
"Count": 1,
"Path": "",
"Type": 16,
"Volume": 536870912000
}
],
"MachineType": "cvm",
"MemDesc": "62.57 GB",
"MemSize": 67186589696,
"Mutable": 1,
"NameTag": "master.3,core.3",
"OrderNo": "tbds-ohizdx8t80",
"Rack": "/rack1",
"RegionId": 1,
"RoleExtTag": "{\"master\":[\"extmaster\"]}",
"RootSize": 0,
"RootStorageType": 0,
"SerialNo": "d4c02725-25cb-4801-87a6-3d9578bb671c",
"ServiceClient": "",
"Services": "AmoroServer,DataNode,Filebeat,HbaseThrift,HiveServer2,HMaster,RegionServer,HttpFS,Impala-Daemon,JobHistoryServer,JournalNode,Kafka,KyuubiServer,NameNode,NodeManager,Zookeeper,TimeLineServer,Trino-Coordinator,ZKFailoverController",
"Spec": "",
"StorageType": 0,
"SubnetInfo": {
"SubnetId": "",
"SubnetName": ""
},
"SupportModifyPayMode": 0,
"SupportRepairDisk": 0,
"Tags": [
{
"TagKey": "auto_custom_tag_1072173869",
"TagValue": "auto_custom_tag_v_1497103071"
}
],
"TradeVersion": 0,
"WanIp": "",
"Zone": "",
"ZoneId": 0
}
],
"RequestId": "8e3f1c96-3280-4191-a82f-b7046d4bc943",
"TagKeys": null,
"TotalCnt": 3
}
}