查询硬件节点信息

最近更新时间:2020-11-18 08:18:26

1. 接口描述

接口请求域名: emr.tencentcloudapi.com 。

查询硬件节点信息

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:emr.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeClusterNodes。
Version String 公共参数,本接口取值:2019-01-03。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 集群实例ID,实例ID形如: emr-xxxxxxxx
NodeFlag String 节点标识,取值为:
  • all:表示获取全部类型节点,cdb信息除外。
  • master:表示获取master节点信息。
  • core:表示获取core节点信息。
  • task:表示获取task节点信息。
  • common:表示获取common节点信息。
  • router:表示获取router节点信息。
  • db:表示获取正常状态的cdb信息。
  • recyle:表示获取回收站隔离中的节点信息,包括cdb信息。
  • renew:表示获取所有待续费的节点信息,包括cdb信息,自动续费节点不会返回。

  • 注意:现在只支持以上取值,输入其他值会导致错误。
    Offset Integer 页编号,默认值为0,表示第一页。
    Limit Integer 每页返回数量,默认值为100,最大值为100。
    HardwareResourceType String 资源类型:支持all/host/pod,默认为all
    SearchFields.N Array of SearchItem 支持搜索的字段

    3. 输出参数

    参数名称 类型 描述
    TotalCnt Integer 查询到的节点总数
    NodeList Array of NodeHardwareInfo 节点详细信息列表
    注意:此字段可能返回 null,表示取不到有效值。
    TagKeys Array of String 用户所有的标签键列表
    注意:此字段可能返回 null,表示取不到有效值。
    HardwareResourceTypeList Array of String 资源类型列表
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取硬件节点信息

    通过emr集群ID获取硬件节点信息

    输入示例

    https://emr.tencentcloudapi.com/?Action=DescribeClusterNodes
    &InstanceId=emr-6deluvd4
    &NodeFlag=all
    &Offset=0
    &Limit=10
    &<公共请求参数>

    输出示例

    {
      "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": [
          "测试一下",
          "alex_test",
          "beckwuxingjia",
          "ghghghg",
          "tag_auth_test",
          "test",
          "beckwu",
          "emr",
          "lg",
          "bk"
        ],
        "TotalCnt": 3
      }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InternalError 内部错误。
    InternalError.AccountCgwError 内部服务调用异常。
    InternalError.CamCgwError 内部服务调用异常。
    InternalError.CamError 内部服务调用异常。
    InternalError.CbsCgwError 内部服务调用异常。
    InternalError.CbsError 内部服务调用异常。
    InternalError.CdbCgwError 内部服务调用异常。
    InternalError.CdbError 内部服务调用异常。
    InternalError.ConfigCgwError 内部服务调用异常。
    InternalError.CvmError 内部服务调用异常。
    InternalError.KmsError 内部服务调用异常。
    InternalError.ProjectCgwError 内部服务调用异常。
    InternalError.SgError 安全组接口调用异常。
    InternalError.TagError 内部服务调用异常。
    InternalError.TradeCgwError 内部服务调用异常。
    InternalError.VpcCgwError 内部服务调用异常。
    InternalError.VpcError 内部服务调用异常。
    InternalError.WoodServerError Woodpecker server调用出错。
    InvalidParameter.InvalidAppId 无效参数,AppId。
    InvalidParameter.InvalidInstanceName 无效的集群名称。
    InvalidParameter.InvalidNodeType 无效的NodeType。
    ResourceNotFound.ClusterNotFound 无法找到该实例。
    ResourceNotFound.InstanceNotFound 无法找到该实例。
    UnsupportedOperation 操作不支持。
    目录