获取终端列表

此方法返回终端列表。

服务

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

computers （对应“计算机与虚拟机”）
virtualmachines （对应“虚拟机”）

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

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

参数

参数	类型	可选	描述
`parentId`	字符串	是	目标公司或组的ID。若未指定或设置为公司ID，则该方法仅返回计算机与群组 . 注意要获取Active Directory端点信息，请使用 getNetworkInventoryItems 方法。
`isManaged`	布尔值	是	用于列出受管或非受管端点的标志。默认未设置该参数，方法将返回所有受管与非受管端点。若设置为 `True` ，则方法仅返回受管端点。
`viewType`	数值	是	虚拟环境清单的视图类型ID。视图类型取决于虚拟化平台。在VMWare集成中，可用选项为： `1` - 主机与集群视图（默认） `2` - 虚拟机视图在Citrix XenServer集成中，可用选项为： `3` - 服务器视图（默认） `4` - 文件夹视图。
`页码`	数字	是	结果页的页码。默认页码为1。
`每页数量`	数字	是	每页返回的项目数量。上限为每页100项。默认值：每页30项。
`筛选器`	对象	是	查询端点列表时使用的筛选器。有关可用筛选器及使用方法的说明，请参阅“可用筛选器”部分。
`选项`	数组	是	一组控制响应中包含哪些信息的选项。

可用筛选器

您可以使用 筛选器 参数按特定属性查询端点。筛选器按章节和子章节结构组织，具体说明如下

查询结果是匹配所有章节及子章节中任意选定筛选器的端点列表。

以下是可用的筛选选项：

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

重要提示

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

字段 名称 支持部分匹配。

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

例如：

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

若 名称 为 *puter ，则API返回名称中包含 puter 的所有终端列表。

可用选项

可通过 options 参数自定义API响应包含的信息。选项按章节和子章节结构组织，具体如下所述。

可用选项包括：

章节	描述
`returnProductOutdated`	布尔值。若为 `真` ，则 `productOutdated` 属性将包含在API响应中。

返回值

此方法返回一个包含端点信息的对象。返回对象包含以下字段：

page - 当前页码
pagesCount - 总页数
perPage - 每页返回条目总数
total - 条目总数
items - 包含端点列表的数组。列表中每个条目具有以下字段：
- id ，受管端点的ID，
- name ，端点名称，
- label ，该端点设置的标签，
- fqdn ，端点的完全限定域名，
- groupId ，端点所属群组ID，
- isManaged ，布尔值 真 ，若该端点受管理
- machineType ，机器类型：(1-计算机，2-虚拟机，3-EC2实例，0-其他)
- operatingSystemVersion ，端点的操作系统版本
- ip ，端点的IP地址
- macs ，端点的MAC地址
- ssid ，端点的SSID（Active Directory SID）
- managedWithBest ，布尔值 真 ，若 BEST 已安装于该端点
- isContainerHost ，布尔值 真 ，若该端点为容器主机
- managedExchangeServer ，布尔值 真 ，若该端点为Exchange服务器
- managedRelay ，布尔值 真 ，若此端点具有中继角色，
- securityServer ，布尔值 True ，若此端点为安全服务器，
managedWithNsx ，布尔值 True ，若此端点来自VMware NSX数据中心。
managedWithVShield ，布尔值 True ，若此端点来自VMware vShield环境。
productOutdated ，布尔值 True ，若该端点缺少一个或多个代理更新。

示例

请求 :

{
      "params": {
           "parentId": "63c6bb02e3cb799758020b99",
           "page": 1,
           "perPage": 10,
           "filters": {
                   "security": {
                            "management": {
                                "managedWithBest": true,
                                "managedRelays": true
				}
                   }
		},
           "options": {
                   "returnProductOutdated": true,
                   "includeScanLogs": true
           }
      },
      "jsonrpc": "2.0",
      "method": "getEndpointsList",
      "id": "301f7b05-ec02-481b-9ed6-c07b97de2b7b"
}

响应 :

{
  "result": {
    "total": 1,
    "page": 1,
    "perPage": 30,
    "pagesCount": 1,
    "items": [
      {
        "id": "64b7625d3c11463ef77e5d6d",
        "name": "string00:16:3e:7f:d3:2e",
        "label": "",
        "fqdn": "s0lc5.wkorh.dsd.ro",
        "groupId": "64b503c21ecee42e130a7bc9",
        "isManaged": true,

        "operatingSystemVersion": "Windows 7 Professional",
        "ip": "231.180.244.114",
        "macs": [
          "00:16:3e:7f:d3:2e"
        ],
        "ssid": "",

        "productOutdated": false,
        "lastSuccessfulScan": {
          "name": "72OHI5dnIH",
          "date": "2023-07-19T04:09:29+00:00"
        }
      }
    ]
  },
  "jsonrpc": "2.0",
  "
}

本节内容 :

获取终端列表

服务

参数

注意

可用筛选器

重要提示

可用选项

返回值

示例

搜索结果