API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 主机安全 > 其他接口 > 获取主机相关统计

获取主机相关统计

最近更新时间：2024-03-12 01:21:19

我的收藏

本页目录：

1. 接口描述

接口请求域名： cwp.tencentcloudapi.com 。

获取主机相关统计

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeGeneralStat。
Version 是 String 公共参数，本接口取值：2018-02-28。
Region 否 String 公共参数，此参数为可选参数。
MachineType 否 String 云主机类型。
  • CVM：表示腾讯云服务器
  • BM: 表示黑石物理机
  • ECM: 表示边缘计算服务器
  • LH: 表示轻量应用服务器
  • Other: 表示混合云机器

    • 示例值：CVM
    MachineRegion 否 String 机器所属地域。如：ap-guangzhou，ap-shanghai
    示例值：ap-guangzhou

    3. 输出参数

    参数名称 类型 描述
    MachinesAll Integer 云主机总数
    示例值：100
    MachinesUninstalled Integer 云主机没有安装主机安全客户端的总数
    示例值：3
    AgentsAll Integer 主机安全客户端总数的总数
    示例值：2
    AgentsOnline Integer 主机安全客户端在线的总数
    示例值：8
    AgentsOffline Integer 主机安全客户端 离线+关机 的总数
    示例值：4
    AgentsPro Integer 主机安全客户端专业版的总数
    示例值：5
    AgentsBasic Integer 主机安全客户端基础版的总数
    示例值：15
    AgentsProExpireWithInSevenDays Integer 7天内到期的预付费专业版总数
    示例值：27
    RiskMachine Integer 风险主机总数
    示例值：6
    Shutdown Integer 已关机总数
    示例值：0
    Offline Integer 已离线总数
    示例值：0
    FlagshipMachineCnt Integer 旗舰版主机数
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：1
    ProtectDays Integer 保护天数
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：1
    AddedOnTheFifteen Integer 15天内新增的主机数
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：12
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 示例

    获取主机安全相关统计

    输入示例

    POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGeneralStat
<公共请求参数>

{}

    输出示例

    {
    "Response": {
        "MachinesAll": 87,
        "MachinesUninstalled": 37,
        "AgentsAll": 50,
        "AgentsOnline": 7,
        "AgentsOffline": 43,
        "AgentsPro": 12,
        "AgentsBasic": 38,
        "AgentsProExpireWithInSevenDays": 1,
        "RiskMachine": 0,
        "Shutdown": 0,
        "Offline": 0,
        "ProtectDays": 1,
        "FlagshipMachineCnt": 1,
        "AddedOnTheFifteen": 1,
        "RequestId": "cf25fc07-0e89-b71f-cb9a-c3fc030ccfd4"
    }
}

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

    错误码 描述
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameter.InvalidFormat 参数格式错误。
    InvalidParameter.ParsingError 参数解析错误。
    InvalidParameterValue 参数取值错误。
    MissingParameter 缺少参数错误。
    中国站