查询集群列表

最近更新时间: 2026-09-17 00:05:51

1. 接口描述

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

查询经典集群列表

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

接口更新时间：2025-09-11 19:07:41。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeInstancesList
Version	是	否	String	公共参数，本接口取值：2019-01-03
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Offset	否	否	Int64	页编号，默认值为0，表示第一页。示例值： 0
Limit	否	否	Int64	每页返回数量，默认值为10，最大值为200。示例值： 10
OrderField	否	否	String	排序字段。取值范围： clusterId：表示按照实例ID排序。 addTime：表示按照实例创建时间排序。 status：表示按照实例的状态码排序。示例值： AddTime
Asc	否	否	Int64	按照OrderField升序或者降序进行排序。取值范围： 0：表示降序。 1：表示升序。默认值为0。示例值： 1
DisplayStrategy	是	否	String	集群筛选策略。取值范围： clusterList：表示查询除了已销毁集群之外的集群列表。 monitorManage：表示查询除了已销毁、创建中以及创建失败的集群之外的集群列表。 cloudHardwareManage/componentManage：目前这两个取值为预留取值，暂时和monitorManage表示同样的含义。示例值： clusterList
Filters	否	否	Array of Filters	支持ClusterId、ClusterName、ClusterStatus、ClusterClass 、EmrVersion 、TagValue、TagKey自定义查询示例值：查看
OrderFields	否	否	Array of OrderField	排序字段根据创建时间AddTime进行排序示例值：查看

3. 输出参数

参数名称	类型	描述
TotalCnt	Int64	符合条件的实例总数。示例值： 1
InstancesList	Array of EmrListInstance	集群实例列表注意：此字段可能返回 null，表示取不到有效值。示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

示例1 查询实例详情

输入示例

https://emr.api3.{{conf.domain_main}}/?Action=DescribeInstancesList
&DisplayStrategy=clusterList
&<公共请求参数>
{
  "Language": "zh",
  "Version": "2019-01-03",
  "Limit": 10,
  "Offset": 0,
  "OrderFields": [],
  "DisplayStrategy": "clusterList",
  "OrderField": "AddTime",
  "Filters": []
}

输出示例

{
  "Response": {
    "InstancesList": [
      {
        "AddTime": "2025-04-11 12:17:47",
        "AlarmInfo": "",
        "AppId": 1255000002,
        "ChargeType": 0,
        "ClusterClass": "Kafka",
        "ClusterId": "tbds-ewu6m1vc",
        "ClusterName": "test-kafka",
        "EmrVersion": "5.3.1.5",
        "HdfsClusterInfo": null,
        "Id": 78000281,
        "IsHandsCluster": true,
        "IsMultiZoneCluster": false,
        "IsSupportOutsideCluster": false,
        "IsWoodpeckerCluster": 1,
        "MasterIp": "10.206.16.120",
        "OutSideSoftInfo": [],
        "ProductId": 74,
        "ProjectId": 0,
        "RegionId": 1,
        "RegionName": "ap-region1",
        "RunTime": "0天2小时28分钟34秒",
        "SecurityClusterInfo": {
          "SecurityClusterId": "tbds-71y29u54",
          "SecurityServices": [
            "ranger-2.3.0",
            "openldap-2.4.44",
            "krb5-1.21.2"
          ]
        },
        "Status": 2,
        "StatusDesc": "集群运行中",
        "SubnetId": 0,
        "SubnetName": "",
        "Tags": [],
        "Uin": "110000000000",
        "UniqSubnetId": "",
        "UniqVpcId": "",
        "VpcId": 0,
        "VpcName": "",
        "Zone": "",
        "ZoneId": 0
      },
      {
        "AddTime": "2025-04-11 12:17:35",
        "AlarmInfo": "",
        "AppId": 1255000002,
        "ChargeType": 0,
        "ClusterClass": "ElasticSearch",
        "ClusterId": "tbds-q7cn47ju",
        "ClusterName": "test-es",
        "EmrVersion": "5.3.1.5",
        "HdfsClusterInfo": null,
        "Id": 78000280,
        "IsHandsCluster": true,
        "IsMultiZoneCluster": false,
        "IsSupportOutsideCluster": false,
        "IsWoodpeckerCluster": 1,
        "MasterIp": "10.206.17.76",
        "OutSideSoftInfo": [],
        "ProductId": 71,
        "ProjectId": 0,
        "RegionId": 1,
        "RegionName": "ap-region1",
        "RunTime": "0天2小时28分钟46秒",
        "SecurityClusterInfo": null,
        "Status": 2,
        "StatusDesc": "集群运行中",
        "SubnetId": 0,
        "SubnetName": "",
        "Tags": [],
        "Uin": "110000000000",
        "UniqSubnetId": "",
        "UniqVpcId": "",
        "VpcId": 0,
        "VpcName": "",
        "Zone": "",
        "ZoneId": 0
      },
      {
        "AddTime": "2025-04-11 12:07:46",
        "AlarmInfo": "",
        "AppId": 1255000002,
        "ChargeType": 0,
        "ClusterClass": "StarRocks",
        "ClusterId": "tbds-cal8t312",
        "ClusterName": "test_sr",
        "EmrVersion": "5.3.1.5",
        "HdfsClusterInfo": null,
        "Id": 78000279,
        "IsHandsCluster": true,
        "IsMultiZoneCluster": false,
        "IsSupportOutsideCluster": false,
        "IsWoodpeckerCluster": 1,
        "MasterIp": "10.206.17.10",
        "OutSideSoftInfo": [],
        "ProductId": 72,
        "ProjectId": 0,
        "RegionId": 1,
        "RegionName": "ap-region1",
        "RunTime": "0天2小时38分钟35秒",
        "SecurityClusterInfo": null,
        "Status": 2,
        "StatusDesc": "集群运行中",
        "SubnetId": 0,
        "SubnetName": "",
        "Tags": [],
        "Uin": "110000000000",
        "UniqSubnetId": "",
        "UniqVpcId": "",
        "VpcId": 0,
        "VpcName": "",
        "Zone": "",
        "ZoneId": 0
      },
      {
        "AddTime": "2025-04-11 12:04:13",
        "AlarmInfo": "",
        "AppId": 1255000002,
        "ChargeType": 0,
        "ClusterClass": "Hadoop",
        "ClusterId": "tbds-6erw96ta",
        "ClusterName": "test-krb",
        "EmrVersion": "5.3.1.5",
        "HdfsClusterInfo": {
          "ClusterId": "tbds-6erw96ta",
          "Services": [
            "hive-3.1.3"
          ]
        },
        "Id": 78000278,
        "IsHandsCluster": true,
        "IsMultiZoneCluster": false,
        "IsSupportOutsideCluster": false,
        "IsWoodpeckerCluster": 1,
        "MasterIp": "10.206.17.160",
        "OutSideSoftInfo": [],
        "ProductId": 70,
        "ProjectId": 0,
        "RegionId": 1,
        "RegionName": "ap-region1",
        "RunTime": "0天2小时42分钟8秒",
        "SecurityClusterInfo": {
          "SecurityClusterId": "tbds-71y29u54",
          "SecurityServices": [
            "ranger-2.3.0",
            "openldap-2.4.44",
            "krb5-1.21.2"
          ]
        },
        "Status": 2,
        "StatusDesc": "集群运行中",
        "SubnetId": 0,
        "SubnetName": "",
        "Tags": [],
        "Uin": "110000000000",
        "UniqSubnetId": "",
        "UniqVpcId": "",
        "VpcId": 0,
        "VpcName": "",
        "Zone": "",
        "ZoneId": 0
      }
    ],
    "RequestId": "ab823d93-c9a3-4e8f-96c9-7654d299b430",
    "TotalCnt": 4
  }
}