获取网络清单项

此方法返回网络清单项。

服务

此方法要求您将 {服务} 名称置于API URL中。允许的服务包括：

计算机 ，对应“计算机与虚拟机”
虚拟机 ，对应“虚拟机”

例如，针对 虚拟机 服务的请求URL为：

https://YOUR-HOSTNAME/api/v1.0/jsonrpc/network/virtualmachines

details成员

部分网络清单项包含一个 details 成员。该成员公开了关于项目的更多信息。具体信息取决于项目类型。

项目类型	详情
`5(计算机)和6(虚拟机)`	`标签` ，为终端设置的标签 `完全限定域名` ，终端的完全限定域名 `组ID` ，终端的组ID `是否受管理` ，布尔值 `真` ，表示该终端是否受管理 `机器类型` ，机器类型：( `1` - 计算机, `2` - 虚拟机, `0` - 其他) `操作系统版本` ，终端的操作系统版本 `IP地址` ，终端的IP地址 `MAC地址` ，终端的MAC地址列表 `安全标识符` ，终端的Active Directory安全标识符 `managedWithBest` ，布尔值 `True` ，如果 BEST 已安装在此终端上 `isContainerHost` ，布尔值 `True` ，如果此终端是容器主机 `managedExchangeServer` ，布尔值 `True` ，如果此终端是Exchange服务器 `managedRelay` ，布尔值 `True` ，如果此终端具有中继角色 `securityServer` ，布尔值 `True` ，如果此终端是安全服务器 `managedWithNsx` ，布尔值 `True` ，如果此终端来自VMware NSX数据中心 `managedWithVShield` ，布尔值 `True` ，如果此终端来自VMware vShield环境 `模块` - 一个对象，用于告知已安装模块及其状态。字段值为布尔类型， `True` - 表示模块已启用，或 `False` - 表示模块已禁用。可用字段包括： `高级威胁控制` `反恶意软件` `内容控制` `设备控制` `防火墙` `高级用户` `加密` `EDR传感器` `超级检测` `补丁管理` `中继` `沙箱分析器` `Exchange` `高级反漏洞利用` `容器保护` `网络攻击防御`

项目类型

详情

5(计算机)和6(虚拟机)

标签 ，为终端设置的标签
完全限定域名 ，终端的完全限定域名
组ID ，终端的组ID
是否受管理 ，布尔值 真 ，表示该终端是否受管理
机器类型 ，机器类型：( 1 - 计算机, 2 - 虚拟机, 0 - 其他)
操作系统版本 ，终端的操作系统版本
IP地址 ，终端的IP地址
MAC地址 ，终端的MAC地址列表
安全标识符 ，终端的Active Directory安全标识符
managedWithBest ，布尔值 True ，如果 BEST 已安装在此终端上
isContainerHost ，布尔值 True ，如果此终端是容器主机
managedExchangeServer ，布尔值 True ，如果此终端是Exchange服务器
managedRelay ，布尔值 True ，如果此终端具有中继角色
securityServer ，布尔值 True ，如果此终端是安全服务器
managedWithNsx ，布尔值 True ，如果此终端来自VMware NSX数据中心
managedWithVShield ，布尔值 True ，如果此终端来自VMware vShield环境
模块 - 一个对象，用于告知已安装模块及其状态。字段值为布尔类型， True - 表示模块已启用，或 False - 表示模块已禁用。可用字段包括：
- 高级威胁控制
- 反恶意软件
- 内容控制
- 设备控制
- 防火墙
- 高级用户
- 加密
- EDR传感器
- 超级检测
- 补丁管理
- 中继
- 沙箱分析器
- Exchange
- 高级反漏洞利用
- 容器保护
- 网络攻击防御

示例

请求 :

{
  "params": {
    "parentId": "5c373e1a1da1974a678b456d",
    "perPage": 100,
    "filters": {
      "type": {
        "groups": true
      },
      "depth": {
        "allItemsRecursively": true
      }
    }
  },
  "jsonrpc": "2.0",
  "method": "getNetworkInventoryItems",
  "id": "tracking"
}

响应 :

{
  "id": "103d7b05-ec02-481b-9ed6-c07b97de2b7a",
  "jsonrpc": "2.0",
  "result": {
    "page": 2,
    "pagesCount": 11,
    "perPage": 1,
    "total": 11,
    "items": [
      {
        "id": "21a295eeb1a43d8b497b24b7",
        "name": "计算机",
        "type": 5,
        "parentId": "21a295eeb1a43d8b497b24b7",
        "companyId": "21a295eeb1a43d8b497b24b7",
        "details": {
          "label": "终端2",
          "fqdn": "endpoint2.local",
          "groupId": "5a5f4d36b1a43d5f097b23bb",
          "isManaged": true,
          "machineType": 2,
          "operatingSystemVersion": "Windows Server",
          "ip": "60.40.10.220",
          "macs": [
            "324935237346"
          ],
          "modules": {
            "advancedThreatControl": false,
            "antimalware": true,
            "contentControl": false,
            "deviceControl": false,
            "firewall": false,
            "powerUser": false,
            "networkAttackDefense": false
          },
          "ssid": ""
        }
      }
    ]
  }
}

参数

参数	类型	可选性	描述
`parentId`	字符串	是	目标公司或组的ID。若未指定，则返回与API密钥关联公司目标下的条目。
`filters`	对象	是	查询端点列表时使用的筛选条件。关于可用筛选条件及其使用方法，请参阅可用筛选条件 .
`viewType`	数值	是	视图类型ID。各虚拟化平台以特定视图展示清单。VMWare集成中的可用选项为： 1 - 主机和集群视图（默认） 2 - 虚拟机视图 Citrix XenServer集成中的可用选项为： 3 - 服务器视图（默认） 4 - 文件夹视图
`page`	数值	是	结果页码。默认页码为1。
`perPage`	数值	是	每页返回的条目数量。上限为每页100条。默认值：每页30条。

可用筛选器

章节	子章节	筛选选项
`类型`		`群组` - 布尔值，用于筛选所有自定义端点组。默认值： `False` . 该筛选器适用于 `计算机` 服务。 `计算机` - 布尔值，用于筛选所有计算机。默认值： `False` . 该筛选器适用于 `计算机` 服务。 `虚拟机` - 布尔值，用于筛选所有虚拟机。默认值： `False` . 该筛选器适用于 `计算机` 和 `虚拟机` 服务。 `集群` - 用于筛选所有虚拟化集群的布尔值。默认值： `False` . 该筛选器适用于 `虚拟机` 服务。 `主机` - 用于筛选所有虚拟化主机的布尔值。默认值： `False` . 该筛选器适用于 `虚拟机` 服务。 `数据中心` - 用于筛选所有数据中心的布尔值。默认值： `False` . 该筛选器适用于 `虚拟机` 服务。 `vApp应用` - 用于筛选所有vShield应用的布尔值。默认值： `False` . 该筛选器适用于 `虚拟机` 服务。 `资源池` - 用于筛选所有资源池的布尔值。默认值： `False` . 该过滤器适用于 `虚拟机` 服务。 `文件夹` - 布尔值，用于筛选所有虚拟化文件夹。默认值： `False` . 该过滤器适用于 `虚拟机` 服务。 `池` - 布尔值，用于筛选所有虚拟化池。默认值： `False` . 该过滤器适用于 `虚拟机` 服务。
`安全`	管理	`最佳管理` - 布尔值，用于筛选所有安装了安全代理的终端。默认值： `False` . 该过滤器适用于 `计算机` 和 `虚拟机` 服务。 `是否为容器主机` - 一个布尔值，用于筛选所有安装了容器主机保护的端点。默认值： `False` . 此筛选器适用于 `计算机` 和 `虚拟机` 服务。 `managedExchangeServers` - 一个布尔值，用于筛选所有受保护的Exchange服务器。默认值： `False` . 此筛选器适用于 `计算机` 和 `虚拟机` 服务。此筛选器需要覆盖该安全服务的有效许可证密钥。 `managedRelays` - 一个布尔值，用于筛选所有具有Relay角色的端点。默认值： `False` . 此筛选器适用于 `计算机` 和 `虚拟机` 服务。 `securityServers` - 一个布尔值，用于筛选所有安全服务器。默认值： `False` . 该过滤器适用于 `计算机` 和 `虚拟机` 服务。 `managedWithNsx` - 布尔值，用于筛选VMware NSX数据中心中受保护的终端。默认值： `False` . 该过滤器适用于 `虚拟机` 服务。此过滤器需要有效的虚拟化许可证密钥。 `managedWithVShield` - 布尔值，用于筛选VMware vShield环境中受保护的终端。默认值： `False` . 该过滤器适用于 `虚拟机` 服务。此过滤器需要有效的虚拟化许可证密钥。
`depth`		`allItemsRecursively` - 布尔值，用于递归筛选公司网络清单中的所有终端。默认值： `False` .
`details`		`ssid` - 字符串，用于根据SSID（终端的Active Directory SID）筛选终端，无论其保护状态如何。 `macs` - 数组，用于过滤终端的MAC地址列表，无论其保护状态如何。 `name` - 字符串，用于按名称过滤条目。最小所需字符串长度为三个字符。

重要提示

部分过滤器需激活特定许可证，否则将被忽略，导致API返回结果不准确。

字段 name 支持部分匹配。

该过滤器返回名称完全匹配或以指定值开头的条目。若需将指定值作为后缀，请使用星号符号(*)。

例如：

若 name 设为 computer ，则API返回所有名称以 computer .

若 name 设为 *puter ，则API返回名称中包含 puter 的所有条目列表。

返回值

此方法返回包含网络条目信息的对象。返回对象包含：

page - 当前页码
pagesCount - 总页数
perPage - 每页返回的项目总数
total - 项目总数
items - 包含项目列表的数组。列表中的每个条目包含以下字段：
- id ，网络项目的ID，
- name ，网络项目的名称，
- parentId ，父容器的ID，
- type ，网络项目的类型： 1 - 公司， 2 - 根容器（公司和网络容器）， 3 - 公司文件夹， 4 - 组， 5 - 计算机， 6 - 虚拟机， 7 - EC2实例， 14 - 容器组, 15 - 容器主机文件夹, 16 - 容器.
- 详情 ，关于该项目的更多信息。此字段适用于 1 - 公司, 5 - 计算机, 6 - 虚拟机, 7 - EC2实例及 16 - 容器。有关详情成员内容的详细信息，请参阅详情成员 .

详情成员

部分网络清单项目包含一个 详情 成员。该成员会公开关于该项目的更多信息，具体信息取决于项目类型。

项目类型	详情
`5(计算机)和6(虚拟机)`	`标签` ，为终端设置的标签 `FQDN` ，终端的完全限定域名 `groupId` ，端点的组ID `isManaged` ，布尔值 `True` ，如果此端点受管理 `machineType` ，机器类型：( `1` - 计算机， `2` - 虚拟机， `0` - 其他) `operatingSystemVersion` ，端点的操作系统版本 `ip` ，端点的IP地址 `macs` ，端点的MAC地址列表 `ssid` ，端点的Active Directory SID `managedWithBest` ，布尔值 `True` ，如果 BEST 安装在此端点上 `isContainerHost` ，布尔值 `真值` ，若该终端为容器主机 `受管理的Exchange服务器` ，布尔型 `真值` ，若该终端为Exchange服务器 `受管理中继` ，布尔型 `真值` ，若该终端具有中继角色 `安全服务器` ，布尔型 `真值` ，若该终端为安全服务器 `由NSX管理` ，布尔型 `真值` ，若该终端来自VMware NSX数据中心 `由vShield管理` ，布尔型 `真值` ，若该终端来自VMware vShield环境 `模块` - 用于描述已安装模块及其状态的对象。字段值为布尔类型， `真值` - 表示模块已启用，或 `假值` - 表示模块已禁用。可用字段包括： `高级威胁控制` `反恶意软件` `内容控制` `设备控制` `防火墙` `高级用户` `加密` `EDR传感器` `超级检测` `补丁管理` `中继` `沙盒分析器` `Exchange` `高级反漏洞利用` `容器保护` `网络攻击防御`