DescribeServiceNodeInfos

Last updated: 2025-11-13 20:49:03

DescribeServiceNodeInfos

Last updated: 2025-11-13 20:49:03

1. API Description

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.

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: 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	Page size.
SearchText	No	String	Searching fields.
ConfStatus	No	Integer	Configuration status. -2: configuration failed; -1: configuration expired; 1: synchronized; -99: all.
MaintainStateId	No	Integer	Filter criteria: Maintenance status 0 indicates all statuses. 1 indicates normal. 2 indicates the maintenance status.
OperatorStateId	No	Integer	Filter criteria: Operation status 0 indicates all statuses. 1 indicates started. 2 indicates stopped.
HealthStateId	No	String	Filter criteria: health status. 0 indicates unavailable. 1 indicates good. -2 indicates unknown. -99 indicates all. -3 indicates potential risks. -4 indicates undetected.
ServiceName	No	String	Service component names (in all caps, for example, YARN).
NodeTypeName	No	String	Node names: master, core, task, common, and router.
DataNodeMaintenanceId	No	Integer	Filter criteria: whether DN is in the maintenance status. 0 indicates all statuses. 1 indicates the maintenance status.
SearchFields.N	No	Array of SearchItem	Searchable fields (currently supported SearchType: ipv4).

3. Output Parameters

Parameter Name	Type	Description
TotalCnt	Integer	Total number.
ServiceNodeList	Array of ServiceNodeDetailInfo	Process information. Note: This field may return null, indicating that no valid values can be obtained.
AliasInfo	String	Alias serialization of all nodes in the cluster.
SupportNodeFlagFilterList	Array of String	Supported FlagNode 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 Querying Service Process Information

This example shows you how to query service process information.

Input Example

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"
}

Output Example

{
    "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": "Port detection 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": "Port detection 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": "Port detection 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": "Port detection 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": "Port detection 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": "Port detection 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
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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.
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.InvalidAppId	Invalid `AppId`.
ResourceNotFound.ClusterNotFound	The instance was not found.
ResourceNotFound.InstanceNotFound	The instance was not found.
UnauthorizedOperation.CheckCamAuth	Unauthorized operation.
UnsupportedOperation.ServiceNotSupport	This operation is not supported.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud