Domain name for API request: emr.intl.tencentcloudapi.com.
This API is used to query information of a cluster node.
A maximum of 20 requests can be initiated per second for this API.
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 ID, such as emr-xxxxxxxx. |
| NodeFlag | Yes | String | Node identifier. Valid values: Note: Only the values above are supported currently. Entering other values will result in an error. |
| ExportDb | No | Boolean | Whether to carry CDB information when all node information is exported in CSV format. |
| Offset | No | Integer | Page number. The default value is 0, indicating the first page. |
| Limit | No | Integer | Number of items returned per page. Default value: 100. Maximum value: 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 (default), host, and pod. |
| SearchFields.N | No | Array of SearchItem | Searchable fields. |
| OrderField | No | String | Sorting field. |
| Asc | No | Integer | Whether to sort data in ascending order. Valid values: 1 (yes) and 0 (no). |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCnt | Integer | Total number of queried nodes. |
| NodeList | Array of NodeHardwareInfo | Node detailed information list. |
| TagKeys | Array of String | List of all tag keys for the user. |
| HardwareResourceTypeList | Array of String | Resource type list. |
| 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. |
This example shows you how to obtain the hardware node information by EMR cluster ID.
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
}{
"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
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 obtain the CAM role. |
| FailedOperation.GetCamServerFailed | Failed to call the CAM service. |
| InternalError | Internal error. |
| InternalError.AccountCgwError | Internal service call exception. |
| InternalError.CamCgwError | Internal service call exception. |
| InternalError.CamError | Internal service call exception. |
| InternalError.CbsCgwError | Internal service call exception. |
| InternalError.CbsError | Internal service call exception. |
| InternalError.CdbCgwError | Internal service call exception. |
| InternalError.CdbError | Internal service call exception. |
| InternalError.ConfigCgwError | Internal service call exception. |
| InternalError.CvmError | Internal service call exception. |
| InternalError.KmsError | Internal service call exception. |
| InternalError.ProjectCgwError | Internal service call exception. |
| InternalError.SgError | An exception occurred when the security group API is called. |
| InternalError.TagError | Internal service call exception. |
| InternalError.TradeCgwError | Internal service call exception. |
| InternalError.VpcCgwError | Internal service call exception. |
| InternalError.VpcError | Internal service call exception. |
| InternalError.WoodServerError | Internal service call exception. |
| InvalidParameter.InvalidAppId | Invalid parameter: APPID. |
| InvalidParameter.InvalidInstanceName | Invalid cluster name. |
| InvalidParameter.InvalidNodeType | Invalid NodeType. |
| ResourceNotFound.ClusterNotFound | The instance cannot be found. |
| ResourceNotFound.InstanceNotFound | The instance cannot be found. |
| UnauthorizedOperation.CheckCamAuth | No permission to verify account operations. |
| UnsupportedOperation | The operation is not supported. |
フィードバック