租户端 大数据 大数据处理套件（TBDS） 集群资源管理相关接口 查询集群节点信息

查询集群节点信息

最近更新时间: 2026-07-12 00:25:32

1. 接口描述

接口请求域名： tbdsnew.api3.fincloud.tencent.com。

查询集群节点信息

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

接口更新时间：2025-07-17 03:48:16。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeClusterNodes
Version 是 否 String 公共参数，本接口取值：2019-01-03
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId 是 否 String 集群实例ID,实例ID形如: emr-xxxxxxxx
示例值： tbds-664nmwbe
NodeFlag 是 否 String 节点标识，取值为：
  • all：表示获取全部类型节点，cdb信息除外。
  • master：表示获取master节点信息。
  • core：表示获取core节点信息。
  • task：表示获取task节点信息。
  • common：表示获取common节点信息。
  • router：表示获取router节点信息。
  • db：表示获取正常状态的cdb信息。
  • recyle：表示获取回收站隔离中的节点信息，包括cdb信息。
  • renew：表示获取所有待续费的节点信息，包括cdb信息，自动续费节点不会返回。
    • 注意：现在只支持以上取值，输入其他值会导致错误。
    示例值： all
    Offset 否 否 Int64 页编号，默认值为0，表示第一页。
    示例值： 0
    Limit 否 否 Int64 每页返回数量，默认值为20，最大值为100。
    示例值： 20
    HardwareResourceType 否 否 String 资源类型:支持all/host/pod，默认为all
    示例值： all
    SearchFields 否 否 Array of SearchItem 支持搜索的字段ip
    示例值：查看
    OrderField 否 否 String 创建时间ApplyTime
    示例值： ApplyTime
    Asc 否 否 Int64 1正序 0倒序
    示例值： 1

    3. 输出参数

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

    4. 错误码

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

    错误码 描述
    InternalError.CbsCgwError 内部服务调用异常。
    InternalError.CvmError 内部服务调用异常。
    FailedOperation.GetCamServerFailed 调用cam服务失败。
    InternalError.CdbCgwError 内部服务调用异常。
    InvalidParameter.InvalidAppId 无效参数，AppId。
    InternalError.WoodServerError 内部服务调用异常。
    InvalidParameter.InvalidInstanceName 无效的集群名称。
    InternalError.ProjectCgwError 内部服务调用异常。
    InternalError.TradeCgwError 内部服务调用异常。
    InternalError.AccountCgwError 内部服务调用异常。
    FailedOperation.GetCamRoleFailed 获取cam角色失败。
    InternalError 内部错误。
    InternalError.VpcError 内部服务调用异常。
    InternalError.KmsError 内部服务调用异常。
    InvalidParameter.InvalidNodeType 无效的NodeType。
    InternalError.VpcCgwError 内部服务调用异常。
    UnsupportedOperation 操作不支持。
    UnauthorizedOperation.CheckCamAuth 校验账号操作无权限。
    InternalError.ConfigCgwError 内部服务调用异常。
    InternalError.CbsError 内部服务调用异常。
    InternalError.SgError 安全组接口调用异常。
    ResourceNotFound.ClusterNotFound 无法找到该实例。
    InternalError.CdbError 内部服务调用异常。
    InternalError.TagError 内部服务调用异常。
    InternalError.CamError 内部服务调用异常。
    InternalError.CamCgwError 内部服务调用异常。
    ResourceNotFound.InstanceNotFound 无法找到该实例。
    FailedOperation 操作失败。