1. 接口描述
接口请求域名: tbdsnew.api3.fincloud.tencent.com。
主机管理-查询主机信息
默认接口请求频率限制:20次/秒。
接口更新时间:2025-08-22 19:53:57。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeHostNodes |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-01-03 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Offset | 否 | 否 | Uint64 | 查询分页的页码 示例值: 1 |
| Limit | 否 | 否 | Uint64 | 查询分页的单页数量 示例值: 1 |
| OrderFields | 否 | 否 | Array of OrderField | 排序字段信息,支持排序的字段包括:"hostName", "ip", "LastHeartTime", "machineType", "rack", "arch", "Os" 示例值:查看 |
| Filters | 否 | 否 | Array of FilterField | 筛选字段信息,支持筛选的字段包括:"onlineStatus", "initStatus", "ip", "clusterName", "machineType", "rack", "config", "tags", "ip_precise" 示例值:查看 |
| NotBindCluster | 否 | 否 | Bool | 是否绑定集群,默认false,若为true表示查询所有未被集群绑定的主机,或仅被公共集群绑定的主机 示例值: False |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCnt | Uint64 | 主机总数量 示例值: 1 |
| ChosenItemNum | Uint64 | 根据条件查询到的主机数量 示例值: 1 |
| HostNodes | Array of HostNodeDetails | 主机详情信息 示例值:查看 |
| HostStatusList | Array of Int64 | 主机的在线状态列表,用于筛选下拉框,-1表示主机离线;1表示主机在线 示例值: 1 |
| HostInitStateList | Array of Int64 | 主机的初始化状态列表,用于筛选下拉框,0-未初始化;1-初始化中;2-已初始化;-1-初始化失败;-2-删除中;3-主机名设置中 示例值: 1 |
| InstanceList | Array of String | 绑定的集群实例列表,用于筛选下拉框,若为空则表示未被集群绑定 示例值: 1 |
| FilterFields | Array of String | 支持筛选的字段列表,用于筛选框 示例值: 1 |
| ArchList | Array of String | 支持的架构列表 示例值: 1 |
| RegionName | String | 地域名称 示例值: 1 |
| IsSupportedMixDeploy | Bool | 当前租户是否支持混合部署,以租户为维度,从配置中获取支持混部的appid列表 示例值: 1 |
| RegionId | Uint64 | 地域ID 示例值: 50000001 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |