1. 接口描述
接口请求域名： emr.tencentcloudapi.com 。
查询集群节点信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeClusterNodes。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-03。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 集群实例ID,实例ID形如: emr-xxxxxxxx 示例值：emr-6deluvd4 |
| NodeFlag | 是 | String | 节点标识，取值为： 注意：现在只支持以上取值，输入其他值会导致错误。 示例值：all |
| ExportDb | 否 | Boolean | 导出全部节点信息csv时是否携带cdb信息 示例值：true |
| Offset | 否 | Integer | 页编号，默认值为0，表示第一页。 示例值：0 |
| Limit | 否 | Integer | 每页返回数量，默认值为100，最大值为100。 如果offset和limit都不填，或者都填0，则返回全部数据 示例值：10 |
| HardwareResourceType | 否 | String | 资源类型:支持all/host/pod，默认为all 示例值：all |
| SearchFields.N | 否 | Array of SearchItem | 支持搜索的字段 |
| OrderField | 否 | String | 无 |
| Asc | 否 | Integer | 无 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCnt | Integer | 查询到的节点总数 示例值：3 |
| NodeList | Array of NodeHardwareInfo | 节点详细信息列表 注意：此字段可能返回 null，表示取不到有效值。 |
| TagKeys | Array of String | 用户所有的标签键列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["\u6d4b\u8bd5\u4e00\u4e0b","alex_test","beckwuxingjia","ghghghg","tag_auth_test","test","beckwu","emr","lg","bk"] |
| HardwareResourceTypeList | Array of String | 资源类型列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取硬件节点信息
通过emr集群ID获取硬件节点信息
输入示例
POST / HTTP/1.1
Host: emr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterNodes
<公共请求参数>
{
"InstanceId": "emr-6deluvd4",
"NodeFlag": "all",
"Limit": "10",
"Offset": "0"
}输出示例
{
"Response": {
"HardwareResourceTypeList": [
"HOST",
"MNode",
"POD"
],
"NodeList": [
{
"AppId": 1258469122,
"ApplyTime": "2024-11-05 20:40:30",
"AutoFlag": 0,
"CdbIp": "",
"CdbNodeInfo": null,
"CdbPort": 0,
"ChargeType": 0,
"Clients": "HDFS,YARN,ZOOKEEPER,FILEBEAT,RUNTIME",
"CpuNum": 4,
"CurrentTime": "2024-11-05 20:44:07",
"Destroyable": 0,
"DeviceClass": "VSELF_5",
"DeviceName": "EMR标准型S5",
"DisableApiTermination": false,
"DiskSize": "200.00 GB",
"DynamicPodSpec": "",
"EmrResourceId": "emr-vm-3ep60g79",
"ExpireTime": "0000-00-00 00:00:00",
"Flag": 2,
"FreeTime": "0000-00-00 00:00:00",
"HardwareResourceType": "HOST",
"HwDiskSize": 214748364800,
"HwDiskSizeDesc": "200.00 GB",
"HwMemSize": 8589934592,
"HwMemSizeDesc": "8GB",
"Ip": "10.233.179.208",
"IsAutoRenew": 1,
"IsDynamicSpec": 0,
"IsFederation": 0,
"MCMultiDisk": [
{
"Count": 1,
"Type": 4,
"Volume": 214748364800
}
],
"MemDesc": "8GB",
"MemSize": 8589934592,
"Mutable": 1,
"NameTag": "core.0",
"OrderNo": "ins-79jcgj7m",
"RegionId": 1,
"Remark": "",
"RootSize": 70,
"RootStorageType": 4,
"SerialNo": "240606f1-dc72-4760-958f-3d11b7430c9f",
"ServiceClient": "",
"Services": "DataNode,Filebeat,NodeManager,Sysctl",
"ServicesStatus": "DataNode:STARTED,Filebeat:STARTED,NodeManager:STARTED,Sysctl:STARTED",
"SharedClusterId": "",
"SharedClusterIdDesc": "",
"Spec": "CVM.S5",
"StorageType": 4,
"SubnetInfo": {
"SubnetId": "subnet-ax8z9f1u",
"SubnetName": "vigo-subnet"
},
"SupportModifyPayMode": 0,
"Tags": [],
"TradeVersion": 1,
"WanIp": "",
"Zone": "ap-guangzhou-3",
"ZoneId": 100003
},
{
"AppId": 1258469122,
"ApplyTime": "2024-11-05 20:40:30",
"AutoFlag": 0,
"CdbIp": "",
"CdbNodeInfo": null,
"CdbPort": 0,
"ChargeType": 0,
"Clients": "HDFS,YARN,ZOOKEEPER,FILEBEAT,RUNTIME",
"CpuNum": 4,
"CurrentTime": "2024-11-05 20:44:07",
"Destroyable": 0,
"DeviceClass": "VSELF_5",
"DeviceName": "EMR标准型S5",
"DisableApiTermination": false,
"DiskSize": "200.00 GB",
"DynamicPodSpec": "",
"EmrResourceId": "emr-vm-az843bs9",
"ExpireTime": "0000-00-00 00:00:00",
"Flag": 2,
"FreeTime": "0000-00-00 00:00:00",
"HardwareResourceType": "HOST",
"HwDiskSize": 214748364800,
"HwDiskSizeDesc": "200.00 GB",
"HwMemSize": 8589934592,
"HwMemSizeDesc": "8GB",
"Ip": "10.233.179.138",
"IsAutoRenew": 1,
"IsDynamicSpec": 0,
"IsFederation": 0,
"MCMultiDisk": [
{
"Count": 1,
"Type": 4,
"Volume": 214748364800
}
],
"MemDesc": "8GB",
"MemSize": 8589934592,
"Mutable": 1,
"NameTag": "core.1",
"OrderNo": "ins-aodlsfs2",
"RegionId": 1,
"Remark": "",
"RootSize": 70,
"RootStorageType": 4,
"SerialNo": "a167d792-3f7d-4927-bc64-70604b4172d2",
"ServiceClient": "",
"Services": "DataNode,Filebeat,NodeManager,Sysctl",
"ServicesStatus": "DataNode:STARTED,Filebeat:STARTED,NodeManager:STARTED,Sysctl:STARTED",
"SharedClusterId": "",
"SharedClusterIdDesc": "",
"Spec": "CVM.S5",
"StorageType": 4,
"SubnetInfo": {
"SubnetId": "subnet-ax8z9f1u",
"SubnetName": "vigo-subnet"
},
"SupportModifyPayMode": 0,
"Tags": [],
"TradeVersion": 1,
"WanIp": "",
"Zone": "ap-guangzhou-3",
"ZoneId": 100003
},
{
"AppId": 1258469122,
"ApplyTime": "2024-11-05 20:40:30",
"AutoFlag": 0,
"CdbIp": "",
"CdbNodeInfo": null,
"CdbPort": 0,
"ChargeType": 0,
"Clients": "HDFS,YARN,ZOOKEEPER,OPENLDAP,KNOX,FILEBEAT,RUNTIME",
"CpuNum": 8,
"CurrentTime": "2024-11-05 20:44:07",
"Destroyable": 0,
"DeviceClass": "VSELF_5",
"DeviceName": "EMR标准型S5",
"DisableApiTermination": false,
"DiskSize": "200.00 GB",
"DynamicPodSpec": "",
"EmrResourceId": "emr-vm-7sgwp92l",
"ExpireTime": "0000-00-00 00:00:00",
"Flag": 1,
"FreeTime": "0000-00-00 00:00:00",
"HardwareResourceType": "HOST",
"HwDiskSize": 214748364800,
"HwDiskSizeDesc": "200.00 GB",
"HwMemSize": 17179869184,
"HwMemSizeDesc": "16GB",
"Ip": "10.233.179.87",
"IsAutoRenew": 1,
"IsDynamicSpec": 0,
"IsFederation": 0,
"MCMultiDisk": [
{
"Count": 1,
"Type": 4,
"Volume": 214748364800
}
],
"MemDesc": "16GB",
"MemSize": 17179869184,
"Mutable": 1,
"NameTag": "master.0",
"OrderNo": "ins-olrawbba",
"RegionId": 1,
"Remark": "",
"RootSize": 70,
"RootStorageType": 4,
"SerialNo": "b8f36fdb-7f78-402e-ace6-63b3d3f277fd",
"ServiceClient": "",
"Services": "Filebeat,gateway,JobHistoryServer,ldap,NameNode,Zookeeper,ResourceManager,slapd,Sysctl,TimeLineServer",
"ServicesStatus": "Filebeat:STARTED,gateway:STARTED,JobHistoryServer:STARTED,ldap:STARTED,NameNode:STARTED,Zookeeper:STARTED,ResourceManager:STARTED,slapd:STARTED,Sysctl:STARTED,TimeLineServer:STARTED",
"SharedClusterId": "",
"SharedClusterIdDesc": "",
"Spec": "CVM.S5",
"StorageType": 4,
"SubnetInfo": {
"SubnetId": "subnet-ax8z9f1u",
"SubnetName": "vigo-subnet"
},
"SupportModifyPayMode": 0,
"Tags": [],
"TradeVersion": 1,
"WanIp": "0.0.0.0",
"Zone": "ap-guangzhou-3",
"ZoneId": 100003
}
],
"RequestId": "ee21e3bd-2340-4501-b63c-2edbcff0f220",
"TagKeys": null,
"TotalCnt": 3
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.GetCamRoleFailed | 获取cam角色失败。 |
| FailedOperation.GetCamServerFailed | 调用cam服务失败。 |
| InternalError | 内部错误。 |
| InternalError.AccountCgwError | 内部服务调用异常。 |
| InternalError.CamCgwError | 内部服务调用异常。 |
| InternalError.CamError | 内部服务调用异常。 |
| InternalError.CbsCgwError | 内部服务调用异常。 |
| InternalError.CbsError | 内部服务调用异常。 |
| InternalError.CdbCgwError | 内部服务调用异常。 |
| InternalError.CdbError | 内部服务调用异常。 |
| InternalError.ConfigCgwError | 内部服务调用异常。 |
| InternalError.CvmError | 内部服务调用异常。 |
| InternalError.KmsError | 内部服务调用异常。 |
| InternalError.ProjectCgwError | 内部服务调用异常。 |
| InternalError.SgError | 安全组接口调用异常。 |
| InternalError.TagError | 内部服务调用异常。 |
| InternalError.TradeCgwError | 内部服务调用异常。 |
| InternalError.VpcCgwError | 内部服务调用异常。 |
| InternalError.VpcError | 内部服务调用异常。 |
| InternalError.WoodServerError | 内部服务调用异常。 |
| InvalidParameter.InvalidAppId | 无效参数，AppId。 |
| InvalidParameter.InvalidInstanceName | 无效的集群名称。 |
| InvalidParameter.InvalidNodeType | 无效的NodeType。 |
| ResourceNotFound.ClusterNotFound | 无法找到该实例。 |
| ResourceNotFound.InstanceNotFound | 无法找到该实例。 |
| UnauthorizedOperation.CheckCamAuth | 校验账号操作无权限。 |
| UnsupportedOperation | 操作不支持。 |
