获取云原生集群列表

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

1. 接口描述

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

获取云原生集群列表

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

接口更新时间:2025-07-17 06:16:39。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeCloudInstancesList
Version String 公共参数,本接口取值:2019-01-03
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
Offset Int64 页编号,默认值为0,表示第一页。
示例值: 0
Limit Int64 每页返回数量,默认值为10,最大值为100。
示例值: 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 自定义查询
    示例值:查看

    3. 输出参数

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

    4. 错误码

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

    错误码 描述
    InvalidParameter.InvalidServiceName 服务名无效。
    InternalError.CbsCgwError 内部服务调用异常。
    InternalError.ProjectCgwError 内部服务调用异常。
    InvalidParameter.InvalidVpcId 无效的私有网络ID。
    FailedOperation.DuplicateOrderNotAllowed 重复的订单,请检查emr控制台。
    InvalidParameter.InvalidSoftWareName 软件名无效。
    ResourceInsufficient.InstanceInsufficient 不支持或售罄的节点规格。
    InvalidParameter.InvalidZone 无效的可用区。
    ResourceNotFound.TagsNotFound 没有查找到指定标签。
    UnsupportedOperation 操作不支持。
    InternalError.SgError 安全组接口调用异常。
    InvalidParameter.InvalidProductId 无效的产品ID。
    InternalError.TradeCgwError 内部服务调用异常。
    InvalidParameter.InvalidInstanceName 无效的集群名称。
    InvalidParameter.ZoneResourceNotMatch 可用区与资源不匹配。
    UnknownParameter 未知参数错误。
    InternalError.CheckQuotaErr cvm或cbs资源不够或软件不合法。
    InvalidParameter.InvalidSoftWareVersion 软件版本无效。
    InternalError.VpcError 内部服务调用异常。
    InvalidParameter.InvalidSoftDeployInfo 参数InvalidSoftDeployInfo无效或错误。
    InternalError.CdbCgwError 内部服务调用异常。
    InvalidParameter.InvalidSoftInfo 无效的SoftInfo。
    InvalidParameter.InvalidResourceSpec 无效的资源规格。
    InternalError.TagError 内部服务调用异常。
    InternalError.CamError 内部服务调用异常。
    InvalidParameter.InvalidSubnetId 无效的子网ID。
    InvalidParameter.PayModeResourceNotMatch 付费模式与资源不匹配。
    InvalidParameter.SoftwareNotInProduct 存在无效的产品组件。
    ResourcesSoldOut.CbsSoldOut CBS资源售罄。
    FailedOperation 操作失败。
    InvalidParameter.InvalidLoginSetting 无效的登录设置。
    InvalidParameter.InvalidSoftWare 参数错误。
    InvalidParameter.DisplayStrategyNotMatch 展示策略错误。
    ResourcesSoldOut 资源售罄。
    InvalidParameter.InvalidDiskSize 无效的磁盘大小。
    InvalidParameter.InvalidTimeUnit 无效的TimeUnit。
    InvalidParameter.InvalidPreExecutedFile 无效的引导操作脚本。
    InvalidParameter.InvalidTimeSpan 无效的timespan。
    InvalidParameter.OrderFieldNotMatch 排序字段错误。
    InternalError.VpcCgwError 内部服务调用异常。
    InvalidParameter.InvalidClientToken 无效的ClientToken。
    InvalidParameter.NotContainMustSelectSoftware 无效参数,不满足必须组件。
    MissingParameter 缺少参数错误。
    InvalidParameter 参数错误。
    InvalidParameter.InvalidPassword 无效密码。
    InvalidParameterValue 参数取值错误。
    InternalError.AccountCgwError 内部服务调用异常。
    InternalError.KmsError 内部服务调用异常。
    InvalidParameter.UngrantedPolicy 策略为授权。
    InvalidParameter.InvalidInstanceType 无效的机型。
    ResourceInsufficient.DiskInsufficient 硬盘规格不满足。
    InvalidParameter.InvalidPaymode 无效的付费类型。
    InvalidParameter.InvalidSercurityGrpupId 无效的安全组ID。
    InternalError.CbsError 内部服务调用异常。
    InvalidParameter.InvalidSupportHA 无效的高可用参数。
    InvalidParameter.InvalidComponent 无效的组件。
    InvalidParameter.InvalidCoreCount Core节点数量无效。
    InvalidParameter.InvalidExtendField CustomConfig参数值无效。
    InvalidParameter.InvalidMetaType 无效的元数据表类型。
    InvalidParameter.InvalidProjectId 无效的项目ID。
    InternalError.CvmError 内部服务调用异常。
    InternalError.CdbError 内部服务调用异常。
    InvalidParameter.UngrantedRole 角色未授权。
    InvalidParameter.InvalidAutoRenew 无效的自动续费标识。
    InternalError.ConfigCgwError 内部服务调用异常。
    ResourcesSoldOut.CvmSoldOut 云服务器已售罄。
    InternalError 内部错误。
    InternalError.CamCgwError 内部服务调用异常。