获取区域主机列表
最近更新时间: 2024-10-18 10:38:45
1. 接口描述
接口请求域名： cwp.api3.fincloud.tencent.cn。
本接口 (DescribeMachines) 用于获取区域主机列表。
默认接口请求频率限制：20次/秒。
接口更新时间：2022-10-18 17:27:47。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeMachines |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-02-28 |
| Region | 是 | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Filters | 否 | 否 | Array of Filter | 过滤条件。<br><li>Ips - String - 是否必填：否 - 通过ip查询 </li><br><li>Names - String - 是否必填：否 - 通过实例名查询 </li><br><li>InstanceIds - String - 是否必填：否 - 通过实例id查询 </li><br><li>Status - String - 是否必填：否 - 客户端在线状态（OFFLINE: 离线/关机 | ONLINE: 在线 | UNINSTALLED：未安装 | AGENT_OFFLINE 离线| AGENT_SHUTDOWN 已关机）</li><br><li>Version - String 是否必填：否 - 当前防护版本（ PRO_VERSION：专业版 | BASIC_VERSION：基础版 | Flagship : 旗舰版 | ProtectedMachines: 专业版+旗舰版）</li><br><li>Risk - String 是否必填: 否 - 风险主机( yes ) </li><br><li>Os -String 是否必填: 否 - 操作系统( DescribeMachineOsList 接口 值 )<br>每个过滤条件只支持一个值，暂不支持多个值“或”关系查询<br><li>Quuid - String - 是否必填: 否 - 云服务器uuid 最大100条.</li><br><li>AddedOnTheFifteen- String 是否必填: 否 - 是否只查询15天内新增的主机( 1：是) </li> |
| Limit | 否 | 否 | Uint64 | 返回数量，默认为10，最大值为100。 |
| MachineRegion | 是 | 否 | String | 机器所属地域。如：ap-guangzhou，ap-shanghai |
| MachineType | 是 | 否 | String | 机器所属专区类型 <br>CVM 云服务器<br>BM 黑石<br>ECM 边缘计算<br>LH 轻量应用服务器<br>Other 混合云专区 |
| Offset | 否 | 否 | Uint64 | 偏移量，默认为0。 |
| ProjectIds | 否 | 否 | Array of Uint64 | 机器所属业务ID列表 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Machines | Machine | 主机列表 |
| TotalCount | Uint64 | 主机数量 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | |
| InvalidParameter.ParsingError | |
| InvalidParameter.MissingParameter | |
| InvalidParameter.InvalidFormat | |
| MissingParameter | |
| InvalidParameter | |
| InvalidParameterValue |