Domain name for API request: emr.intl.tencentcloudapi.com.
This API is used to query service process information.
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: DescribeServiceNodeInfos. |
| 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 | Instance ID. |
| Offset | No | Integer | Page number. |
| Limit | No | Integer | Number of entries per page. |
| SearchText | No | String | Searching field. |
| ConfStatus | No | Integer | 'Configuration status. Valid values: -2 (configuration failed), -1 (configuration expired), 1 (synchronized)', and -99 '(all)'. |
| MaintainStateId | No | Integer | Filter criterion, which specifies the maintenance status. Valid values: 0: all statuses 1: normal mode 2: maintenance mode |
| OperatorStateId | No | Integer | Filter criterion, which specifies the operation status. Valid values: 0: all statuses 1: started 2: stopped. |
| HealthStateId | No | String | Filter criterion, which specifies the health status. Valid values: "0": unavailable "1": good -2: unknown -99: all statuses -3: potential risk -4: undetected |
| ServiceName | No | String | Service component name, which must be specified by using uppercase letters (for example, YARN). Select either the service component name or ServiceGroupType in an API call and ensure that the selected item is required. |
| NodeTypeName | No | String | Node name. Valid values: master, core, task, common, and router. |
| DataNodeMaintenanceId | No | Integer | Filter criterion, which specifies whether the data node is in maintenance. Valid values: 0: all statuses 1: maintenance status |
| SearchFields.N | No | Array of SearchItem | Searchable fields (Currently, SearchType: ipv4 is supported). |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCnt | Integer | Total number. |
| ServiceNodeList | Array of ServiceNodeDetailInfo | Process information. |
| AliasInfo | String | Alias serialization of all nodes in the cluster. |
| SupportNodeFlagFilterList | Array of String | List of supported flag nodes. |
| 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 service process information.
POST / HTTP/1.1
Host: emr.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeServiceNodeInfos
<Common request parameters>
{
"InstanceId": "emr-3u",
"Limit": 999,
"Offset": 0,
"ServiceName": "HIVE"
}{
"Response": {
"AliasInfo": "13141313",
"RequestId": "a90a9922-dc51-45a6-abdd-93f63cf02e57",
"ServiceNodeList": [
{
"ConfGroupId": 623383,
"ConfGroupName": "hive-master-defaultGroup",
"ConfStatus": 1,
"DataNodeMaintenanceState": 0,
"Flag": 1,
"HAState": "",
"HealthStatus": {
"Code": 1,
"Desc": "The port probe responds within 5s.",
"Text": "Good"
},
"Ip": "10.0.0.0",
"IsFederation": false,
"IsSupportRoleMonitor": true,
"LastRestartTime": "2024-08-16 14:13:32",
"MonitorStatus": 1,
"NameService": "",
"NodeFlagFilter": "master",
"NodeName": "HiveMetaStore",
"NodeType": 30,
"PortsInfo": "",
"ServiceDetectionInfo": [],
"ServiceStatus": 1,
"Status": 1,
"StopPolicies": null
},
{
"ConfGroupId": 623383,
"ConfGroupName": "hive-master-defaultGroup",
"ConfStatus": 1,
"DataNodeMaintenanceState": 0,
"Flag": 1,
"HAState": "",
"HealthStatus": {
"Code": 1,
"Desc": "The port probe responds within 5s.",
"Text": "Good"
},
"Ip": "10.0.0.0",
"IsFederation": false,
"IsSupportRoleMonitor": true,
"LastRestartTime": "2024-08-16 14:14:24",
"MonitorStatus": 1,
"NameService": "",
"NodeFlagFilter": "master",
"NodeName": "HiveMetaStore",
"NodeType": 30,
"PortsInfo": "",
"ServiceDetectionInfo": [],
"ServiceStatus": 1,
"Status": 1,
"StopPolicies": null
},
{
"ConfGroupId": 623383,
"ConfGroupName": "hive-master-defaultGroup",
"ConfStatus": 1,
"DataNodeMaintenanceState": 0,
"Flag": 1,
"HAState": "",
"HealthStatus": {
"Code": 1,
"Desc": "The port probe responds within 5s.",
"Text": "Good"
},
"Ip": "10.0.0.0",
"IsFederation": false,
"IsSupportRoleMonitor": true,
"LastRestartTime": "2024-08-16 14:14:47",
"MonitorStatus": 1,
"NameService": "",
"NodeFlagFilter": "master",
"NodeName": "HiveServer2",
"NodeType": 31,
"PortsInfo": "",
"ServiceDetectionInfo": [],
"ServiceStatus": 1,
"Status": 1,
"StopPolicies": null
},
{
"ConfGroupId": 623383,
"ConfGroupName": "hive-master-defaultGroup",
"ConfStatus": 1,
"DataNodeMaintenanceState": 0,
"Flag": 1,
"HAState": "",
"HealthStatus": {
"Code": 1,
"Desc": "The port probe responds within 5s.",
"Text": "Good"
},
"Ip": "10.0.0.0",
"IsFederation": false,
"IsSupportRoleMonitor": true,
"LastRestartTime": "2024-08-16 14:14:54",
"MonitorStatus": 1,
"NameService": "",
"NodeFlagFilter": "master",
"NodeName": "HiveServer2",
"NodeType": 31,
"PortsInfo": "",
"ServiceDetectionInfo": [],
"ServiceStatus": 1,
"Status": 1,
"StopPolicies": null
},
{
"ConfGroupId": 623383,
"ConfGroupName": "hive-master-defaultGroup",
"ConfStatus": 1,
"DataNodeMaintenanceState": 0,
"Flag": 1,
"HAState": "",
"HealthStatus": {
"Code": 1,
"Desc": "The port probe responds within 5s.",
"Text": "Good"
},
"Ip": "10.0.0.0",
"IsFederation": false,
"IsSupportRoleMonitor": true,
"LastRestartTime": "2024-08-16 14:15:11",
"MonitorStatus": 1,
"NameService": "",
"NodeFlagFilter": "master",
"NodeName": "HiveWebHcat",
"NodeType": 32,
"PortsInfo": "",
"ServiceDetectionInfo": [],
"ServiceStatus": 1,
"Status": 1,
"StopPolicies": null
},
{
"ConfGroupId": 623383,
"ConfGroupName": "hive-master-defaultGroup",
"ConfStatus": 1,
"DataNodeMaintenanceState": 0,
"Flag": 1,
"HAState": "",
"HealthStatus": {
"Code": 1,
"Desc": "The port probe responds within 5s.",
"Text": "Good"
},
"Ip": "10.0.0.0",
"IsFederation": false,
"IsSupportRoleMonitor": true,
"LastRestartTime": "2024-08-16 14:15:39",
"MonitorStatus": 1,
"NameService": "",
"NodeFlagFilter": "master",
"NodeName": "HiveWebHcat",
"NodeType": 32,
"PortsInfo": "",
"ServiceDetectionInfo": [],
"ServiceStatus": 1,
"Status": 1,
"StopPolicies": null
}
],
"SupportNodeFlagFilterList": [
"master",
"core",
"task",
"common",
"router"
],
"TotalCnt": 6
}
}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. |
| 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 | Parameter error. |
| InvalidParameter.InvalidAppId | Invalid parameter: APPID. |
| ResourceNotFound.ClusterNotFound | The instance cannot be found. |
| ResourceNotFound.InstanceNotFound | The instance cannot be found. |
| UnauthorizedOperation.CheckCamAuth | No permission to verify account operations. |
| UnsupportedOperation.ServiceNotSupport | This service does not support this operation. |
フィードバック