1. 接口描述
接口请求域名： tbdsnew.api3.fincloud.tencent.com。
查询集群概览基本信息，包括集群状态、节点数量、metaDB状态、hive元数据库状态等
默认接口请求频率限制：20次/秒。
接口更新时间：2024-11-01 11:29:49。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeClusterOverview |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-01-03 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 集群ID 示例值： tbds-lpzpjomo |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ComponentNum | Int64 | 组件个数 示例值： 1 |
| DbStatus | Int64 | DB状态 示例值： 1 |
| DbStatusDesc | String | DB状态描述 示例值： 1 |
| InstanceNum | Int64 | 集群节点个数 示例值： 1 |
| Status | Int64 | 集群状态 示例值： 1 |
| StatusDesc | String | 集群状态描述 示例值： 1 |
| HiveCdbStatus | Int64 | hive元数据库状态 示例值： 1 |
| HiveCdbStatusDesc | String | hive元数据库状态描述 示例值： 1 |
| EventNum | Int64 | 发生的事件数量 示例值： 1 |
| IpStack | String | Ip Stack类型 示例值： 1 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ImpalaQueryException | impala查询参数异常。 |
| InternalError.ClickHouseQueryException | 查询ClickHouse异常。 |
| ResourceNotFound.ClusterNotFound | 无法找到该实例。 |