跳至主内容

获取受控端点详情

getManagedEndpointDetails方法用于获取 GravityZone .

参数

参数

描述

包含在请求中

类型

取值

endpointId

待返回详情的终端点ID。

必填

字符串

必须是有效的受管终端点ID。

提示

您可以通过 getEndpointsList 方法获取受管终端点列表,需包含 isManaged 参数并设置为 true .

options

用于控制响应信息内容的选项集合。

可选

对象

有关此对象的详细信息,请参阅 options .

对象

options

您可以使用 选项 参数可用于自定义API响应中包含的信息。选项按章节和子章节进行组织,具体描述如下。

以下是可用的选项:

章节

描述

includeScanLogs

布尔值。若为true,则 lastSuccessfulScan 属性将包含在API响应中。默认值: false .

返回值

此方法返回一个包含指定端点详细信息的对象:

  • id - 受管端点的ID

  • name - 端点名称

  • companyId - 端点所属公司的ID

  • operatingSystem - 端点的操作系统

  • state - 机器的电源状态: 1 - 在线, 2 - 离线, 3 - 挂起, 0 - 未知

    注意

    以下状态仅针对配置在 GravityZone :

    • 2 - 离线

    • 3 - 已挂起

  • ip - 端点的IP地址

  • lastSeen - 上次与 控制中心

  • machineType - 机器类型: 1 - 计算机, 2 - 虚拟机, 3 - EC2实例, 0 - 其他

  • agent - 包含端点所安装代理的以下信息的对象:

    • engineVersion ,扫描引擎版本

    • primaryEngine ,扫描恶意软件时优先使用的引擎。可能包含以下值之一:

      • 1 - 中央扫描(安全服务器)

      • 2 - 混合扫描(轻量引擎)

      • 3 - 本地扫描(完整引擎)

      • 0 - 未知

    • fallbackEngine ,当任务发送时主引擎不可用时的备用引擎。可选值如下:

      • 2 - 混合扫描(轻量引擎)

      • 3 - 本地扫描(完整引擎)

      • 0 - 未知

    • lastUpdate ,最后一次特征库更新的日期和时间

    • licensed ,许可证状态: 0 - 待认证 1 - 有效许可证 2 - 过期许可证 6 - 无许可证或不适用

    • productOutdated ,布尔值,表示代理版本是否为最新

    • productUpdateDisabled ,一个布尔值,表示产品更新是否被禁用

    • productVersion ,代理程序的版本号

    • signatureOutdated ,一个布尔值,表示终端的反恶意软件签名是否已过时

    • signatureUpdateDisabled ,一个布尔值,表示反恶意软件签名更新是否被禁用

    • type ,标识终端上安装的代理程序类型:

      • 1 - 终端安全

      • 2 - Bitdefender工具

      • 3 - BEST

  • group - 一个对象,指向终端所属的组。该对象包含以下字段:

    • id ,组的ID

    • name ,组的名称

  • malwareStatus - 一个对象,提供与恶意软件相关的终端状态信息。该对象包含以下字段:

    • detection ,一个布尔值,表示过去24小时内是否在终端上检测到恶意软件,

    • infected ,一个布尔值,表示反恶意软件是否已成功清除感染或终端仍处于感染状态

  • policy - 一个对象,用于告知终端上生效的策略。该对象包含以下内容:

    • id ,活动策略的ID,

    • name ,策略的名称,

    • applied ,布尔值,若策略当前已应用于终端则设为True

  • modules - 一个对象,用于告知已安装模块及其状态。各字段为布尔值, True - 表示模块已启用, False - 表示模块已禁用。可用字段包括:

    • advancedThreatControl

    • antimalware

    • contentControl

    • deviceControl

    • firewall

    • powerUser

    • encryption

    • edrSensor

    • hyperDetect

    • patchManagement

    • relay

    • sandboxAnalyzer

    • exchange

    • advancedAntiExploit

    • containerProtection

    • networkAttackDefense

    • 完整性监控

  • 标签 - 字符串,设置给该端点的标签

  • 移动状态 - 反映端点移动状态的整数: 0 - 无移动操作, 1 - 移出公司, 2 - 移入本公司。

  • 由BEST管理 - 布尔值,若端点安装了代理( BEST )则设为True。

  • 是否为容器主机 - 布尔值,若端点是容器主机则设为True。

  • 受管理的Exchange服务器 - 布尔值,若端点是Exchange服务器则设为True。

  • 受管理中继 - 布尔值,若端点具有中继角色则设为True。

  • 安全服务器 - 布尔值,若端点是安全服务器则设为True。

  • 风险评分 - 包含以下端点安全风险信息的对象:

    • ,端点安全风险评分值(百分比),可分解为配置错误和应用漏洞

    • 影响 ,端点安全风险影响(低、中、高)

    • 配置错误 ,终端安全风险评分中错误配置的占比

    • appVulnerabilities ,终端安全风险评分中应用漏洞的占比

    • humanRisks ,终端安全风险评分中人为风险的占比

  • lastSuccessfulScan ,对象。包含以下详细信息:

    • name - 扫描名称

    • date - 扫描执行日期

示例

请求 :

{
       "params": {
           "endpointId" : "54a28b41b1a43d89367b23fd","options": {
               "includeScanLogs": true
            }},
       "jsonrpc": "2.0",
       "method": "getManagedEndpointDetails",
       "id": "301f7b05-ec02-481b-9ed6-c07b97de2b7b"
  }

响应 :

{
      "id":"0df7568c-59c1-48e0-a31b-18d83e6d9810",
      "jsonrpc":"2.0",
      "result": {
          'id': '54a28b41b1a43d89367b23fd',
          'name': 'WIN-TGQDU499RS4',
          'companyId': '5575a235d2172c65038b454e',
          'operatingSystem': 'Windows Server 2008 R2 Datacenter',
          'state': 1,
          'ip': '10.10.24.154',
          'lastSeen': '2015-06-22T13:46:59',
          'machineType': 1,
          'agent': {
               'engineVersion': '7.61184',
               'primaryEngine': 1,
               'fallbackEngine': 2,
               'lastUpdate': '2015-06-22T13:40:06',
               'licensed': 1,
               'productOutdated': False,
               'productUpdateDisabled': False,
               'productVersion': '6.2.3.569',
               'signatureOutdated': False,
               'signatureUpdateDisabled': False,
               'type': 3
           },
          'group': {
               'id': '5575a235d2172c65038b456d',
               'name': '自定义组'
           },
          'malwareStatus': {
               'detection': False,
               'infected': False
           },
          'modules': {
               'advancedThreatControl': False,
               'antimalware': True,
               'contentControl': False,
               'deviceControl': False,
               'firewall': False,
               'powerUser': False,
               'networkAttackDefense': False'integrityMonitoring: False,},
          'policy': {
               'id': '5121da426803fa2d0e000017',
               'applied': True,
               'name': '默认策略'
           },
           "label" : "终端标签","moveState": 1,
           "riskScore": {
                "value": "81%",
                "impact": "高",
                "misconfigurations": "70%",
                "appVulnerabilities": "11%",
                "humanRisks": "19%"
           },
"lastSuccessfulScan": {
                "name": "72OHI5dnIH",
                "date": "2023-07-19T04:09:29+00:00"
           },

      }
  }