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

查询集群实例信息

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

1. 接口描述

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

查询经典集群实例信息

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

接口更新时间：2024-11-01 09:14:30。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeInstances
Version 是 否 String 公共参数，本接口取值：2019-01-03
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceIds 否 否 Array of String 按照一个或者多个实例ID查询。实例ID形如: emr-xxxxxxxx 。(此参数的具体格式可参考API简介的 Ids.N 一节)。如果不填写实例ID，返回该APPID下所有实例列表。
示例值： ['tbds-nu7ckm3g']
Offset 否 否 Int64 页编号，默认值为0，表示第一页。
示例值： 1
Limit 否 否 Int64 每页返回数量，默认值为10，最大值为100。
示例值： 1
ProjectId 否 否 Int64 建议必填-1，表示拉取所有项目下的集群。
不填默认值为0，表示拉取默认项目下的集群。
实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。
示例值： 1
OrderField 否 否 String 排序字段。取值范围：
  • clusterId：表示按照实例ID排序。
  • addTime：表示按照实例创建时间排序。
  • status：表示按照实例的状态码排序。

    • 示例值： 1
    Asc 否 否 Int64 按照OrderField升序或者降序进行排序。取值范围：
  • 0：表示降序。
  • 1：表示升序。
    • 默认值为0。
    示例值： 1
    DisplayStrategy 是 否 String 集群筛选策略。取值范围：
  • clusterList：表示查询除了已销毁集群之外的集群列表。
  • monitorManage：表示查询除了已销毁、创建中以及创建失败的集群之外的集群列表。
  • cloudHardwareManage/componentManage：目前这两个取值为预留取值，暂时和monitorManage表示同样的含义。

    • 示例值： clusterList

    3. 输出参数

    参数名称 类型 描述
    TotalCnt Int64 符合条件的实例总数。
    示例值： 1
    ClusterList Array of ClusterInstancesInfo EMR实例详细信息列表。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：查看
    TagKeys Array of String 实例关联的标签键列表。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值： 1
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

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

    错误码 描述
    InternalError.CbsCgwError 内部服务调用异常。
    InternalError.CdbCgwError 内部服务调用异常。
    InternalError 内部错误。
    InternalError.ConfigCgwError 内部服务调用异常。
    FailedOperation 操作失败。
    InvalidParameter.InvalidInstanceName 无效的集群名称。
    InternalError.CamCgwError 内部服务调用异常。
    InternalError.TradeCgwError 内部服务调用异常。
    InvalidParameter.InvalidClusterId 无效参数，ClusterId。
    InternalError.CamError 内部服务调用异常。
    InternalError.VpcError 内部服务调用异常。
    InternalError.SgError 安全组接口调用异常。
    FailedOperation.GetCamServerFailed 调用cam服务失败。
    ResourceNotFound.InstanceNotFound 无法找到该实例。
    InternalError.ProjectCgwError 内部服务调用异常。
    FailedOperation.GetCamRoleFailed 获取cam角色失败。
    InvalidParameter.OrderFieldNotMatch 排序字段错误。
    InternalError.CvmError 内部服务调用异常。
    InternalError.WoodServerError 内部服务调用异常。
    UnauthorizedOperation.CheckCamAuth 校验账号操作无权限。
    InternalError.KmsError 内部服务调用异常。
    InvalidParameter.DisplayStrategyNotMatch 展示策略错误。
    ResourceNotFound.ClusterNotFound 无法找到该实例。
    InvalidParameter 参数错误。
    InternalError.AccountCgwError 内部服务调用异常。
    InternalError.CbsError 内部服务调用异常。
    InternalError.CdbError 内部服务调用异常。
    ResourceNotFound.HardwareInfoNotFound 无法找到硬件信息。
    InternalError.TagError 内部服务调用异常。
    InternalError.VpcCgwError 内部服务调用异常。