1. 接口描述
接口请求域名: tbdsnew.api3.fincloud.tencent.com。
在集群资源的节点状态下,节点列表下获取集群的节点信息,包括节点类型及其CPU和内存利用率等
默认接口请求频率限制:20次/秒。
接口更新时间:2024-12-06 06:26:10。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeInstanceNodes |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-01-03 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 集群名 示例值: tbds-1vzudj86 |
| Host | 否 | 否 | String | ip, 当根据ip查询时传入 示例值: |
| EmrNodeType | 否 | 否 | String | 节点类型,当根据节点类型查询时传入 master\core等 示例值: |
| Offset | 否 | 否 | Int64 | 分页页号,默认值为0,表示第一页 示例值: 0 |
| Limit | 否 | 否 | Int64 | 每页容量,默认值为10,最大值为100 示例值: 10 |
| Sort | 否 | 否 | String | 排序方向,不传则不排序 取值有desc和asc 示例值: |
| SortBy | 否 | 否 | String | 根据那个字段来排序,取值有cpu、memory、disk 示例值: |
| AgentStatus | 否 | 否 | Int64 | agent状态,-1:离线,1:在线 ,不筛选前端可不传默认是0 示例值: -99 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Offset | Int64 | 页号 示例值: 1 |
| TotalPage | Int64 | 总页数 示例值: 1 |
| ChosenItemNum | Int64 | 已选数量 示例值: 1 |
| TotalCount | Int64 | 总数量 示例值: 1 |
| InstanceNodeList | Array of InstanceNodeItem | 节点描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:查看 |
| EmrNodeTypes | Array of String | EMR节点类型数组 注意:此字段可能返回 null,表示取不到有效值。 示例值: 1 |
| AliasInfo | String | 别名数组信息,base64编码 示例值: 1 |
| AgentStatusFilter | Array of Int64 | 状态筛选列表 注意:此字段可能返回 null,表示取不到有效值。 示例值: 1 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.InvalidClusterId | 无效参数,ClusterId。 |
| ResourceNotFound.ClusterNotFound | 无法找到该实例。 |