DescribeClusterNodes

Last updated: 2020-05-15 11:47:33

PDF

1. API Description

Domain name for API request: emr.tencentcloudapi.com.

This API is used to query the information of a hardware node.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: emr.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeClusterNodes.
Version Yes String Common parameter. The value used for this API: 2019-01-03.
Region Yes String Common parameter. 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:
  • all: gets the information of nodes in all types except TencentDB information.
  • master: gets master node information.
  • core: gets core node information.
  • task: gets task node information.
  • common: gets common node information.
  • router: gets router node information.
  • db: gets TencentDB information in normal status.

  • Note: only the above values are supported for the time being. Entering other values will cause errors.
    Offset No Integer Page number. Default value: 0, indicating the first page.
    Limit No Integer Number of returned results per page. Default value: 100. Maximum value: 100

    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.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting hardware node information

    This example shows you how to get the information of a hardware node by EMR cluster ID.

    Input Example

    https://emr.tencentcloudapi.com/?Action=DescribeClusterNodes
    &InstanceId=emr-6deluvd4
    &NodeFlag=all
    &Offset=0
    &Limit=10
    &<common request parameters>

    Output Example

    {
      "Response": {
        "NodeList": [
          {
            "AppId": 251008830,
            "ApplyTime": "2020-02-24 20:31:06",
            "CdbIp": "",
            "CdbNodeInfo": null,
            "CdbPort": 0,
            "ChargeType": 0,
            "CpuNum": 8,
            "Destroyable": 0,
            "DeviceClass": "VSELF_2",
            "DiskSize": "100.00 GB",
            "EmrResourceId": "emr-vm-6xyf2cb2",
            "ExpireTime": "0000-00-00 00:00:00",
            "Flag": 1,
            "FreeTime": "0000-00-00 00:00:00",
            "HwDiskSize": 107374182400,
            "HwDiskSizeDesc": "100.00 GB",
            "HwMemSize": 17179869184,
            "HwMemSizeDesc": "16GB",
            "Ip": "10.0.0.76",
            "IsAutoRenew": 0,
            "MCMultiDisk": [
              {
                "Count": 1,
                "Type": 5,
                "Volume": 107374182400
              }
            ],
            "MemDesc": "16GB",
            "MemSize": 17179869184,
            "Mutable": 1,
            "NameTag": "master.0",
            "OrderNo": "ins-20224atg",
            "RegionId": 1,
            "RootSize": 0,
            "SerialNo": "83d977e5-fa68-4051-875e-ad30ff42534f",
            "Services": "Zookeeper,NameNode,ResourceManager,JobHistoryServer,HMaster,HbaseThrift,HiveServer2,HiveMetaStore,HiveWebHcat,Spark,SparkJobHistoryServer,Presto-Coordinator,knox",
            "Spec": "CVM.S2",
            "StorageType": 5,
            "Tags": [],
            "WanIp": "--",
            "ZoneId": 100002
          },
          {
            "AppId": 251008830,
            "ApplyTime": "2020-02-24 20:31:07",
            "CdbIp": "",
            "CdbNodeInfo": null,
            "CdbPort": 0,
            "ChargeType": 0,
            "CpuNum": 8,
            "Destroyable": 0,
            "DeviceClass": "VSELF_2",
            "DiskSize": "100.00 GB",
            "EmrResourceId": "emr-vm-cinlo2wc",
            "ExpireTime": "0000-00-00 00:00:00",
            "Flag": 2,
            "FreeTime": "0000-00-00 00:00:00",
            "HwDiskSize": 107374182400,
            "HwDiskSizeDesc": "100.00 GB",
            "HwMemSize": 17179869184,
            "HwMemSizeDesc": "16GB",
            "Ip": "10.0.0.33",
            "IsAutoRenew": 0,
            "MCMultiDisk": [
              {
                "Count": 1,
                "Type": 5,
                "Volume": 107374182400
              }
            ],
            "MemDesc": "16GB",
            "MemSize": 17179869184,
            "Mutable": 1,
            "NameTag": "core.0",
            "OrderNo": "ins-20224gpk",
            "RegionId": 1,
            "RootSize": 0,
            "SerialNo": "8ded940b-a579-4c81-be75-3aaf62137337",
            "Services": "DataNode,NodeManager,RegionServer,Presto-Worker",
            "Spec": "CVM.S2",
            "StorageType": 5,
            "Tags": [],
            "WanIp": "",
            "ZoneId": 100002
          },
          {
            "AppId": 251008830,
            "ApplyTime": "2020-02-24 20:31:08",
            "CdbIp": "",
            "CdbNodeInfo": null,
            "CdbPort": 0,
            "ChargeType": 0,
            "CpuNum": 8,
            "Destroyable": 0,
            "DeviceClass": "VSELF_2",
            "DiskSize": "100.00 GB",
            "EmrResourceId": "emr-vm-b32qad6s",
            "ExpireTime": "0000-00-00 00:00:00",
            "Flag": 2,
            "FreeTime": "0000-00-00 00:00:00",
            "HwDiskSize": 107374182400,
            "HwDiskSizeDesc": "100.00 GB",
            "HwMemSize": 17179869184,
            "HwMemSizeDesc": "16GB",
            "Ip": "10.0.0.111",
            "IsAutoRenew": 0,
            "MCMultiDisk": [
              {
                "Count": 1,
                "Type": 5,
                "Volume": 107374182400
              }
            ],
            "MemDesc": "16GB",
            "MemSize": 17179869184,
            "Mutable": 1,
            "NameTag": "core.1",
            "OrderNo": "ins-202241if",
            "RegionId": 1,
            "RootSize": 0,
            "SerialNo": "c045bcd7-571a-4c64-b0a5-9024c94d5c15",
            "Services": "DataNode,NodeManager,RegionServer,Presto-Worker",
            "Spec": "CVM.S2",
            "StorageType": 5,
            "Tags": [],
            "WanIp": "",
            "ZoneId": 100002
          }
        ],
        "RequestId": "bb22bafb-d2a4-4a02-879f-6ccf54a27892",
        "TagKeys": [
          "Test",
          "alex_test",
          "beckwuxingjia",
          "ghghghg",
          "tag_auth_test",
          "test",
          "beckwu",
          "emr",
          "lg",
          "bk"
        ],
        "TotalCnt": 3
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    SDK

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

    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
    InternalError Internal error.
    InternalError.AccountCgwError An error occurred when calling other service API.
    InternalError.CamCgwError An error occurred when calling other service API.
    InternalError.CamError An error occurred when calling other service API.
    InternalError.CbsCgwError An error occurred when calling other service API.
    InternalError.CbsError An error occurred when calling other service API.
    InternalError.CdbCgwError An error occurred when calling other service API.
    InternalError.CdbError An error occurred when calling other service API.
    InternalError.ConfigCgwError An error occurred when calling other service API.
    InternalError.CvmError An error occurred when calling other service API.
    InternalError.KmsError An error occurred when calling other service API.
    InternalError.ProjectCgwError An error occurred when calling other service API.
    InternalError.SgError An error occurred when calling security group API.
    InternalError.TagError An error occurred when calling other service API.
    InternalError.TradeCgwError An error occurred when calling other service API.
    InternalError.VpcCgwError An error occurred when calling other service API.
    InternalError.VpcError An error occurred when calling other service API.
    InternalError.WoodServerError An error occurred when calling the Woodpecker server.
    InvalidParameter.InvalidAppId Invalid AppId.
    InvalidParameter.InvalidNodeType Invalid NodeType.
    ResourceNotFound.ClusterNotFound The instance was not found.
    UnsupportedOperation Unsupported operation.