Release Notes
Announcements
Security Announcements
Domain name for API request: emr.intl.tencentcloudapi.com.
This API is used to query the information of instances in a cluster.
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: DescribeInstances. |
| 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. |
| DisplayStrategy | Yes | String | Cluster filtering policy. Valid values:monitorManage. |
| InstanceIds.N | No | Array of String | Queries by one or more instance IDs in the format of emr-xxxxxxxx. For the format of this parameter, please see the id.N section in API Overview. If no instance ID is entered, the list of all instances under this APPID will be returned. |
| Offset | No | Integer | Page number. Default value: 0, indicating the first page. |
| Limit | No | Integer | Number of returned results per page. Default value: 10. Maximum value: 100 |
| ProjectId | No | Integer | ID of the project to which the instance belongs. This parameter can be obtained from the projectId field in the return value of the DescribeProject API. If this value is -1, the list of all instances will be returned. |
| OrderField | No | String | Sorting field. Valid values: |
| Asc | No | Integer | Sorts according to OrderField in ascending or descending order. Valid values: |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCnt | Integer | Number of eligible instances. |
| ClusterList | Array of ClusterInstancesInfo | List of EMR instance details. Note: this field may return null, indicating that no valid values can be obtained. |
| TagKeys | Array of String | List of tag keys associated to an instance. 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. |
This example shows you how to query instance details.
POST / HTTP/1.1
Host: emr.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<Common request parameters>
{
"DisplayStrategy": "clusterList",
"ProjectId": "0",
"Asc": "0",
"Limit": "10",
"OrderField": "clusterid",
"Offset": "0",
"InstanceIds": [
"emr-p9f700x8"
]
}{
"Response": {
"ClusterList": [
{
"AddTime": "2024-11-05 20:39:44",
"AlarmInfo": "",
"AliasInfo": "eyJjb21tb24iOiJjb21tb24iLCJjb3JlIjoiY29yZSIsIm1hc3RlciI6Im1hc3RlciIsInRhc2siOiJ0YXNrIn0=",
"AppId": 1334143,
"ChargeType": 0,
"ClusterExternalServiceInfo": null,
"ClusterId": "emr-hvijzo6n",
"ClusterName": "odinlli_test_1105",
"ClusterTitle": "Cluster Is Running",
"Config": {
"ApplicationRole": "",
"CbsEncrypt": 0,
"ChargeType": 0,
"ComNodeSize": 0,
"ComResource": {
"Cpu": 0,
"DiskSize": 0,
"DiskType": "",
"InstanceType": "",
"MemSize": 0,
"RootSize": 0,
"Spec": "",
"SpecName": "",
"StorageType": 0
},
"CoreNodeSize": 2,
"CoreResource": {
"Cpu": 4,
"DiskSize": 200,
"DiskType": "CLOUD_SSD",
"InstanceType": "",
"MemSize": 8192,
"RootSize": 70,
"Spec": "CVM.S5",
"SpecName": "EMR Standard S5",
"StorageType": 4
},
"MasterNodeSize": 1,
"MasterResource": {
"Cpu": 8,
"DiskSize": 200,
"DiskType": "CLOUD_SSD",
"InstanceType": "",
"MemSize": 16384,
"RootSize": 70,
"Spec": "CVM.S5",
"SpecName": "EMR Standard S5",
"StorageType": 4
},
"OnCos": false,
"PublicKeyId": "",
"RouterNodeSize": 0,
"SecurityGroup": "sg-jfluz1nt",
"SecurityGroups": [
"sg-jfluz1nt"
],
"SecurityOn": false,
"SoftInfo": [
"hdfs-3.2.2",
"yarn-3.2.2",
"zookeeper-3.6.3",
"openldap-2.4.44",
"knox-1.6.1"
],
"SupportHA": false,
"TaskNodeSize": 0,
"TaskResource": {
"Cpu": 0,
"DiskSize": 0,
"DiskType": "",
"InstanceType": "",
"MemSize": 0,
"RootSize": 0,
"Spec": "",
"SpecName": "",
"StorageType": 0
}
},
"ConfigDetail": {
"ApplicationRole": "",
"CbsEncrypt": 0,
"ChargeType": 0,
"ComNodeSize": 0,
"ComResource": {
"Cpu": 0,
"DiskSize": 0,
"DiskType": "",
"InstanceType": "",
"MemSize": 0,
"RootSize": 0,
"Spec": "",
"SpecName": "",
"StorageType": 0
},
"CoreNodeSize": 2,
"CoreResource": {
"Cpu": 4,
"DiskSize": 200,
"DiskType": "CLOUD_SSD",
"InstanceType": "",
"MemSize": 8192,
"RootSize": 70,
"Spec": "CVM.S5",
"SpecName": "EMR Standard S5",
"StorageType": 4
},
"MasterNodeSize": 1,
"MasterResource": {
"Cpu": 8,
"DiskSize": 200,
"DiskType": "CLOUD_SSD",
"InstanceType": "",
"MemSize": 16384,
"RootSize": 70,
"Spec": "CVM.S5",
"SpecName": "EMR Standard S5",
"StorageType": 4
},
"OnCos": false,
"PublicKeyId": "",
"RouterNodeSize": 0,
"SecurityGroup": "sg-jfluz1nt",
"SecurityGroups": [
"sg-jfluz1nt"
],
"SecurityOn": false,
"SoftInfo": [
"hdfs-3.2.2",
"yarn-3.2.2",
"zookeeper-3.6.3",
"openldap-2.4.44",
"knox-1.6.1"
],
"SupportHA": false,
"TaskNodeSize": 0,
"TaskResource": {
"Cpu": 0,
"DiskSize": 0,
"DiskType": "",
"InstanceType": "",
"MemSize": 0,
"RootSize": 0,
"Spec": "",
"SpecName": "",
"StorageType": 0
}
},
"DisplayName": "Default Scenario",
"EmrVersion": "EMR-V3.5.0",
"Ftitle": "Cluster Is Running",
"HiveMetaDb": "",
"Id": 1113,
"IsCvmReplace": false,
"IsMultiZoneCluster": false,
"IsTradeCluster": 0,
"IsWoodpeckerCluster": 1,
"MasterIp": "0.0.0.0",
"MetaDb": "",
"ProductId": 44,
"ProjectId": 0,
"RegionId": 1,
"ResourceOrderId": 0,
"RunTime": "0 day 0 hour 32 minutes and 20 seconds",
"SceneEmrVersion": "EMR-V3.5.0",
"SceneName": "Hadoop-Default",
"SceneServiceClass": "Hadoop",
"ServiceClass": "HADOOP",
"Status": 2,
"SubnetId": 6131299,
"SubnetName": "vigo-subnet",
"Tags": [],
"TopologyInfoList": [
{
"NodeInfoList": [
{
"NodeSize": 2,
"NodeType": "Core"
},
{
"NodeSize": 0,
"NodeType": "Task"
},
{
"NodeSize": 0,
"NodeType": "Router"
},
{
"NodeSize": 0,
"NodeType": "Common"
},
{
"NodeSize": 1,
"NodeType": "Master"
}
],
"SubnetInfoList": [
{
"SubnetId": "subnet-ax8z9f1u",
"SubnetName": "vigo-subnet"
}
],
"Zone": "ap-guangzhou-3",
"ZoneId": 100003
}
],
"TradeVersion": 1,
"Uin": "0000000",
"UniqSubnetId": "subnet-ax8z9f1u",
"UniqVpcId": "vpc-r2g15ki3",
"VpcId": 10421586,
"VpcName": "vigo-vpc",
"Zone": "ap-guangzhou-3",
"ZoneId": 100003
}
],
"RequestId": "7fd5fb20-1b1f-4425-ad13-1763f0f7f8dc",
"TagKeys": [],
"TotalCnt": 1
}
}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.DescribeResourceTagsFailed | Failed to fetch resource tag. |
| 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 | Invalid parameter. |
| InvalidParameter.DisplayStrategyNotMatch | Incorrect display policy. |
| InvalidParameter.InvalidClusterId | Invalid parameter: ClusterId. |
| InvalidParameter.InvalidInstanceName | Invalid cluster name. |
| InvalidParameter.OrderFieldNotMatch | Invalid sorting field. |
| ResourceNotFound.ClusterNotFound | The instance was not found. |
| ResourceNotFound.HardwareInfoNotFound | No hardware information found. |
| ResourceNotFound.InstanceNotFound | The instance was not found. |
| UnauthorizedOperation.CheckCamAuth | Unauthorized operation. |
フィードバック