1. 接口描述
接口请求域名: cwp.api3.fincloud.tencent.cn。
获取主机相关统计
默认接口请求频率限制:20次/秒。
接口更新时间:2022-08-19 10:10:24。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeGeneralStat |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-02-28 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| Filters | 否 | 否 | Array of Filters | 过滤参数 CloudFrom:0 云平台、1 Other、2 阿里云、3 华为云、4 亚马逊、5 微软、6 Google、7 Oracle、8 Digital Ocean、9 百度 示例值:查看 |
| MachineRegion | 否 | 否 | String | 机器所属地域 示例值: ap-region1 |
| MachineType | 否 | 否 | String | 云主机类型。 示例值: CVM |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AddedOnTheFifteen | Uint64 | 15天内新增的主机数 示例值: 12 |
| AgentsAll | Uint64 | 主机安全客户端总数的总数 示例值: 2 |
| AgentsBasic | Uint64 | 主机安全客户端基础版的总数 示例值: 15 |
| AgentsOffline | Uint64 | 主机安全客户端 离线+关机 的总数 示例值: 4 |
| AgentsOnline | Uint64 | 主机安全客户端在线的总数 示例值: 8 |
| AgentsPro | Uint64 | 主机安全客户端专业版的总数 示例值: 5 |
| AgentsProExpireWithInSevenDays | Uint64 | 7天内到期的预付费专业版总数 示例值: 27 |
| FlagshipMachineCnt | Uint64 | 旗舰版主机数 示例值: 1 |
| MachinesAll | Uint64 | 云主机总数 示例值: 100 |
| MachinesUninstalled | Uint64 | 云主机没有安装主机安全客户端的总数 示例值: 3 |
| Offline | Uint64 | 已离线总数 示例值: 0 |
| ProtectDays | Uint64 | 保护天数 示例值: 1 |
| RiskMachine | Uint64 | 风险主机总数 示例值: 6 |
| Shutdown | Uint64 | 已关机总数 示例值: 0 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter.ParsingError | 参数解析错误。 |
| InvalidParameter.InvalidFormat | 参数格式错误。 |
| MissingParameter | 缺少参数错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |