DescribeClusterNodes
Last updated: 2025-11-13 20:49:17
DescribeClusterNodes
Last updated: 2025-11-13 20:49:17
1. API Description
Domain name for API request: emr.intl.tencentcloudapi.com.
This API is used to query the information of nodes in a cluster.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeClusterNodes. |
| Version | Yes | String | Common Params. The value used for this API: 2019-01-03. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Cluster instance ID in the format of emr-xxxxxxxx |
| NodeFlag | Yes | String | Node flag. Valid values: Note: only the above values are supported for the time being. Entering other values will cause errors. |
| ExportDb | No | Boolean | Whether to carry CDB information when all node information is exported in CSV format. |
| Offset | No | Integer | Page number. Default value: 0, indicating the first page. |
| Limit | No | Integer | Number of records to be returned per page. The default value is 100, and the maximum value is 100. If both offset and limit are not set, or both are set to 0, all data will be returned. |
| HardwareResourceType | No | String | Resource type. Valid values: all, host, pod. Default value: all |
| SearchFields.N | No | Array of SearchItem | Searchable field |
| OrderField | No | String | Order field. |
| Asc | No | Integer | Ascending or not. 1: ascending; 0: descending. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCnt | Integer | Total number of queried nodes |
| NodeList | Array of NodeHardwareInfo | List of node details Note: this field may return null, indicating that no valid values can be obtained. |
| TagKeys | Array of String | List of tag keys owned by user Note: this field may return null, indicating that no valid values can be obtained. |
| HardwareResourceTypeList | Array of String | Resource type list Note: this field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Obtaining Information of a Hardware Node
This example shows you how to obtain the information of a hardware node by EMR cluster ID.
Input Example
POST / HTTP/1.1
Host: emr.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterNodes
<Common request parameters>
{
"InstanceId": "emr-6deluvd4",
"NodeFlag": "all",
"Limit": "10",
"Offset": "0"
}Output Example
{
"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 Standard 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 Standard 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 Standard 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. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.GetCamRoleFailed | Failed to query the CAM role. |
| FailedOperation.GetCamServerFailed | Failed to call the CAM service. |
| InternalError | Internal error. |
| InternalError.AccountCgwError | An error occurred while calling another service API. |
| InternalError.CamCgwError | An error occurred while calling another service API. |
| InternalError.CamError | An error occurred while calling another service API. |
| InternalError.CbsCgwError | An error occurred while calling another service API. |
| InternalError.CbsError | An error occurred while calling another service API. |
| InternalError.CdbCgwError | An error occurred while calling another service API. |
| InternalError.CdbError | An error occurred while calling another service API. |
| InternalError.ConfigCgwError | An error occurred while calling another service API. |
| InternalError.CvmError | An error occurred while calling another service API. |
| InternalError.KmsError | An error occurred while calling another service API. |
| InternalError.ProjectCgwError | An error occurred while calling another service API. |
| InternalError.SgError | An error occurred when calling a security group API. |
| InternalError.TagError | An error occurred while calling another service API. |
| InternalError.TradeCgwError | An error occurred while calling another service API. |
| InternalError.VpcCgwError | An error occurred while calling another service API. |
| InternalError.VpcError | An error occurred while calling another service API. |
| InternalError.WoodServerError | An error occurred while calling another service API. |
| InvalidParameter.InvalidAppId | Invalid AppId. |
| InvalidParameter.InvalidInstanceName | Invalid cluster name. |
| InvalidParameter.InvalidNodeType | Invalid NodeType. |
| ResourceNotFound.ClusterNotFound | The instance was not found. |
| ResourceNotFound.InstanceNotFound | The instance was not found. |
| UnauthorizedOperation.CheckCamAuth | Unauthorized operation. |
| UnsupportedOperation | Unsupported operation. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback