1. 接口描述
接口请求域名： tbdsnew.api3.fincloud.tencent.cn。
查询云原生集群详情
默认接口请求频率限制：20次/秒。
接口更新时间：2025-07-17 06:15:41。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeCloudInstance |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-01-03 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 实例ID 示例值： 1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ClusterInfo | ClusterInfos | 集群信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：查看 |
| NamespaceQuotaInfo | NamespaceQuotaInfo | 命名空间信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.CbsCgwError | 内部服务调用异常。 |
| InternalError.CdbCgwError | 内部服务调用异常。 |
| ResourcesSoldOut | 资源售罄。 |
| InternalError | 内部错误。 |
| InvalidParameter.InvalidPassword | 无效密码。 |
| ResourcesSoldOut.CvmSoldOut | 云服务器已售罄。 |
| InvalidParameter.InvalidVpcId | 无效的私有网络ID。 |
| InvalidParameter.PayModeResourceNotMatch | 付费模式与资源不匹配。 |
| InternalError.ConfigCgwError | 内部服务调用异常。 |
| InvalidParameter.InvalidExtendField | CustomConfig参数值无效。 |
| InvalidParameter.InvalidSoftWare | 参数错误。 |
| FailedOperation | 操作失败。 |
| InvalidParameter.InvalidInstanceName | 无效的集群名称。 |
| InternalError.CamCgwError | 内部服务调用异常。 |
| InvalidParameter.InvalidPaymode | 无效的付费类型。 |
| InvalidParameter.InvalidPreExecutedFile | 无效的引导操作脚本。 |
| InvalidParameter.InvalidProductId | 无效的产品ID。 |
| UnsupportedOperation | 操作不支持。 |
| InvalidParameter.InvalidClientToken | 无效的ClientToken。 |
| InvalidParameter.InvalidSubnetId | 无效的子网ID。 |
| InvalidParameter.SoftwareNotInProduct | 存在无效的产品组件。 |
| MissingParameter | 缺少参数错误。 |
| InvalidParameter.InvalidSoftWareName | 软件名无效。 |
| InvalidParameter.InvalidSupportHA | 无效的高可用参数。 |
| ResourceInsufficient.InstanceInsufficient | 不支持或售罄的节点规格。 |
| InvalidParameter.InvalidAppId | 无效参数，AppId。 |
| InternalError.TradeCgwError | 内部服务调用异常。 |
| InvalidParameter.UngrantedPolicy | 策略为授权。 |
| UnknownParameter | 未知参数错误。 |
| InternalError.TKEError | TKE调用出错。 |
| ResourceInsufficient.DiskInsufficient | 硬盘规格不满足。 |
| InvalidParameter.InvalidClusterId | 无效参数，ClusterId。 |
| InternalError.CamError | 内部服务调用异常。 |
| InvalidParameter.InvalidMetaType | 无效的元数据表类型。 |
| ResourceNotFound.TagsNotFound | 没有查找到指定标签。 |
| InvalidParameter.InvalidSoftInfo | 无效的SoftInfo。 |
| InvalidParameter.InvalidZone | 无效的可用区。 |
| ResourcesSoldOut.CbsSoldOut | CBS资源售罄。 |
| InternalError.VpcError | 内部服务调用异常。 |
| InternalError.SgError | 安全组接口调用异常。 |
| FailedOperation.DuplicateOrderNotAllowed | 重复的订单，请检查emr控制台。 |
| InvalidParameter.InvalidSercurityGrpupId | 无效的安全组ID。 |
| ResourceNotFound.InstanceNotFound | 无法找到该实例。 |
| InvalidParameter.InvalidInstanceType | 无效的机型。 |
| InvalidParameter.InvalidAutoRenew | 无效的自动续费标识。 |
| InternalError.ProjectCgwError | 内部服务调用异常。 |
| InvalidParameter.InvalidDiskSize | 无效的磁盘大小。 |
| InternalError.EKSError | 调用EKS报错。 |
| InvalidParameter.InvalidCoreCount | Core节点数量无效。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameter.InvalidServiceName | 服务名无效。 |
| InternalError.CheckQuotaErr | cvm或cbs资源不够或软件不合法。 |
| InvalidParameter.InvalidSoftDeployInfo | 参数InvalidSoftDeployInfo无效或错误。 |
| InvalidParameter.ZoneResourceNotMatch | 可用区与资源不匹配。 |
| InvalidParameter.InvalidLoginSetting | 无效的登录设置。 |
| InvalidParameter.InvalidResourceSpec | 无效的资源规格。 |
| InvalidParameter.InvalidSoftWareVersion | 软件版本无效。 |
| InternalError.CvmError | 内部服务调用异常。 |
| InvalidParameter.InvalidProjectId | 无效的项目ID。 |
| InternalError.KmsError | 内部服务调用异常。 |
| InvalidParameter.InvalidTimeUnit | 无效的TimeUnit。 |
| InvalidParameter.InvalidComponent | 无效的组件。 |
| FailedOperation.GetEksServerFailed | 获取eks服务失败。 |
| InvalidParameter.NotContainMustSelectSoftware | 无效参数，不满足必须组件。 |
| InvalidParameter | 参数错误。 |
| InternalError.AccountCgwError | 内部服务调用异常。 |
| InternalError.CbsError | 内部服务调用异常。 |
| InternalError.CdbError | 内部服务调用异常。 |
| InvalidParameter.InvalidTimeSpan | 无效的timespan。 |
| InternalError.TagError | 内部服务调用异常。 |
| InternalError.VpcCgwError | 内部服务调用异常。 |
| InvalidParameter.UngrantedRole | 角色未授权。 |
5. 示例
示例1 集群详情
输入示例
POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeCloudInstance
<公共请求参数>
{
"DisplayStrategy": "clusterList",
"Limit": 10,
"Field": [],
"Asc": 1,
"Offset": 0,
"OrderField": "AddTime",
"Filters": [
{
"Name": "ClusterType",
"Values": [
"1"
]
}
]
}
输出示例
{
"Response": {
"InstancesList": [
{
"AddTime": "2025-05-15 14:24:24",
"AlarmInfo": "",
"AppId": 1255000002,
"ChargeType": 0,
"Class": "",
"ClusterId": "tbds-aqy2cvg6",
"ClusterName": "公共基础集群",
"EmrVersion": "EMR-TKE-COMMON-5.3.1.5",
"Id": 78000002,
"IsPermission": true,
"IsWoodpeckerCluster": 1,
"ProjectId": 0,
"RegionId": 1,
"RegionName": "",
"ResourceUsage": {
"Cpu": "0core",
"Mem": "0GB"
},
"RunTime": "11天5小时9分钟5秒",
"Soft": [
"openldap-2.4.44",
"krb5-1.21.2",
"ranger-2.3.0",
"knox-1.6.1",
"zookeeper-3.7.2",
"metaservice-0.7.0"
],
"Status": 2,
"StatusDesc": "集群运行中",
"SubnetId": 0,
"Tags": null,
"TkeClusterId": "global",
"VpcId": 0
}
],
"RequestId": "66d2b3ac-3d27-4235-bde8-b239589565f6",
"TotalCnt": 1
}
}