1. 接口描述
接口请求域名: tbdsnew.api3.fincloud.tencent.com。
集群概览中节点状态TOP10,获取集群中节点对应的监控信息
默认接口请求频率限制:20次/秒。
接口更新时间:2024-12-07 07:37:23。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeTopNByHost |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-01-03 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Start | 否 | 否 | Int64 | 起始时间戳(精确到秒) 示例值: 1748250407 |
| End | 是 | 否 | Int64 | 终止时间戳(精确到秒) 示例值: 1748254007 |
| Downsample | 是 | 否 | String | Downsample值 示例值: 30s-max |
| Metric | 是 | 否 | String | 指标名 示例值: EMR.78000005.NODE.CPU |
| Host | 否 | 否 | String | 主机Ip 示例值: 1 |
| Aggregator | 否 | 否 | String | 聚合方法,eg:sum/avg/min/max/none 示例值: 1 |
| Tags | 否 | 否 | String | 过滤维度,eg:{"host":"172.16.0.197","type":"State"} 示例值: 1 |
| Offset | 否 | 否 | Int64 | 保留字段,当前版本暂未支持 示例值: 1 |
| Limit | 否 | 否 | Int64 | 保留字段,当前版本暂未支持 示例值: 1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Hosts | Array of TopNHostMetrics | 主机监控数据列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:查看 |
| TotalCnt | Int64 | 总数 示例值: 1 |
| Resu | String | 结果 示例值: 1 |
| AliasInfo | String | 别名数组信息,base64编码 示例值: 1 |
| Unit | String | 单位,EMR字段暂未使用 示例值: 1 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InternalError | 内部错误。 |
| InternalError.OpenTSDBHttpReturnCodeNotOK | 请求OpenTSDB失败。 |
| InvalidParameter.ImpalaQueryException | impala查询参数异常。 |
| ResourceNotFound | 资源不存在。 |
| InvalidParameter.InvalidClusterId | 无效参数,ClusterId。 |
| ResourceNotFound.HardwareInfoNotFound | 无法找到硬件信息。 |
| InternalError.DoOpenTSDBRequestException | 请求OpenTSDB异常。 |
| InternalError.DBQueryException | DB查询异常。 |