获取端点列表

参数

参数	类型	可选	描述
`父级ID`	字符串	是	目标公司或组的ID。若未指定，则该方法返回与API密钥关联公司目标范围内的项目。注意要获取Active Directory终端信息，请使用 getNetworkInventoryItems 方法。
`isManaged`	布尔值	是	用于列出受管或非受管终端的标志。默认情况下该参数未设置，方法将返回所有受管与非受管终端。若设置为 `True` ，则方法仅返回受管终端。
`page`	数值	是	结果页码。默认值： `1` .
`perPage`	数值	是	每页返回的条目数量。可选值： `1` - `1000` . 默认值：30。
`筛选器`	对象	是	用于自定义要检索的端点类型的参数。有关可用筛选器及其使用方式的信息，请参阅“可用筛选器”部分。
`选项`	对象	是	一组控制响应中包含哪些信息的选项。

可用筛选器

您可以使用 筛选器 参数按特定属性查询端点。筛选器按章节和子章节进行结构化，具体如下所述

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

以下是可用的筛选选项：

章节	子章节	筛选选项
`安全`	管理	`managedWithBest` - 布尔值，用于筛选安装了安全代理的所有端点。默认值： `False` . `managedExchangeServers` - 布尔值，用于筛选所有受保护的Exchange服务器。默认值： `False` . 此筛选器需要覆盖安全服务的有效许可证密钥。 `managedRelays` - 布尔值，用于筛选所有具有Relay角色的终端。默认值： `False` . `securityServers` - 布尔值，用于筛选所有安全服务器。默认值： `False` .
`depth`		`allItemsRecursively` - 布尔值，用于递归筛选公司网络清单中的所有终端。默认值： `False` .
`details`		`ssid` - 字符串，用于通过SSID（终端的Active Directory SID）筛选终端，无论其保护状态如何。 `macs` - 数组，用于通过MAC地址列表筛选终端，无论其保护状态如何。 `name` - 字符串，用于通过名称筛选终端，无论其保护状态如何。最小字符串长度为三个字符。

重要提示

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

字段 name 支持部分匹配。

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

例如：

若 name 为 计算机 ，则API返回名称以 计算机 .

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

可选参数

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

可用选项如下：

章节	描述
`returnProductOutdated`	布尔值。若为 `true` ，则响应中包含 `productOutdated` 属性。
`includeScanLogs`	布尔值。若为true，则响应中包含 `lastSuccessfulScan` 属性。默认值： `false` .

返回值

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

page - 当前显示页面的页码。
pagesCount - 总页数。

注意

该属性仅在首页显示。
perPage - 每页显示的项目总数。
total - 请求返回的项目总数。

注意

该属性仅在首页显示。
hasMoreRecords - 布尔值，表示下一页是否存在更多记录。
items - 包含端点列表的数组。列表中每个条目包含以下字段：
- id ，托管端点的ID，
- name ，端点名称，
- label ，为该端点设置的标签，
- fqdn ，端点的完全限定域名，
- groupId ，端点的组ID，
- isManaged ，布尔值 True ，若该端点受管理，
- machineType ，机器类型：(1-计算机，2-虚拟机，3-EC2实例，0-其他)，
- operatingSystemVersion ，端点的操作系统版本，
- ip ，端点的IP地址，
- macs ，端点的MAC地址，
- ssid ，端点的SSID（Active Directory SID），
- managedWithBest ，布尔值 True ，若 BEST 已安装在此端点上，
- isContainerHost ，布尔值 True ，若该端点为容器主机，
- managedExchangeServer ，布尔值 True ，若该端点为Exchange服务器，
- managedRelay ，布尔值 True ，若该端点具有中继角色，
- securityServer , boolean True , 若此端点为安全服务器，
- policy , 一个对象，用于告知端点上生效的策略。该对象包含以下字段：
  - id - 唯一标识当前策略的字符串，
  - name - 策略名称，
  - applied - 布尔值，若策略当前已应用于端点则为True，
movingInfo , 一个对象，用于告知端点从一家公司迁移至另一家公司的信息。该对象包含：
- state - 端点迁移状态（0 - 进行中，1 - 已完成），
- destinationCompanyName - 端点迁入的公司名称。
productOutdated , boolean True , 若端点缺少一个或多个代理更新。
lastSuccessfulScan , 对象。包含以下详细信息：
- name - 扫描名称。
- date - 执行扫描的日期。

示例

请求 :

{
      "params": {
           "parentId": "63c6bb02e3cb799758020b99",
           "page": 1,
           "perPage": 3,
           "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": 8,
    "page": 1,
    "perPage": 3,
    "pagesCount": 3,
    "hasMoreRecords": true,
    "items": [
      {
        "id": "64b7625d3c11463ef77e5d6d",
        "name": "string00:16:3e:7f:d3:2e",
        "label": "",
        "fqdn": "s0lc5.wkorh.dsd.ro",
        "groupId": "64b503c21ecee42e130a7bc9",
        "isManaged": true,"machineType": 1,"operatingSystemVersion": "Windows 7 专业版",
        "ip": "231.180.244.114",
        "macs": [
          "00:16:3e:7f:d3:2e"
        ],
        "ssid": "","managedWithBest": true,
        "policy": {
          "id": "64b76bed92f0176fa203b64c",
          "name": "新策略",
          "applied": false
        },"productOutdated": false,
        "lastSuccessfulScan": {
          "name": "72OHI5dnIH",
          "date": "2023-07-19T04:09:29+00:00"
        }
      }
    ]
  },
  "jsonrpc": "2.0",
  "id": "5986",
  "error": null
}

{
  "result": {
    "page": 2,
    "perPage": 3,
    "hasMoreRecords": true,
    "items": [
      {
       ...
      }
    ]
  },
  "jsonrpc": "2.0",
  "id": "5986",
  "error": null
}

版本 1.0

参数

参数	类型	可选	描述
`parentId`	字符串	是	目标公司或组的ID。若未指定或设置为公司ID，则该方法仅返回计算机与组 . 注意要获取Active Directory端点信息，请使用 getNetworkInventoryItems 方法。
`isManaged`	布尔值	是	用于列出受管或非受管端点的标志。默认情况下不设置该参数，方法将返回所有受管和非受管端点。若设置为 `True` ，则方法仅返回受管端点。
`page`	数字	是	结果页码。默认页码为1。
`perPage`	数字	是	每页返回的条目数。上限为每页100条。默认值：每页30条。
`filters`	对象	是	查询端点列表时使用的过滤器。关于可用过滤器及其使用方法，请参阅“可用过滤器”部分。
`options`	数组	是	控制响应中包含信息的一组选项。

可用过滤器

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

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

以下是可用过滤选项：

章节	子章节	筛选选项
`安全`	管理	`managedWithBest` - 布尔值，用于筛选安装了安全代理的所有终端。默认值： `False` . `managedExchangeServers` - 布尔值，用于筛选所有受保护的Exchange服务器。默认值： `False` . 此筛选器需要覆盖安全服务的有效许可证密钥。 `managedRelays` - 布尔值，用于筛选具有中继角色的所有终端。默认值： `False` . `securityServers` - 布尔值，用于筛选所有安全服务器。默认值： `False` .
`深度`		`allItemsRecursively` - 布尔值，用于在公司网络清单中递归筛选所有终端。默认值： `False` .
`详情`		`ssid` - 字符串，用于通过终端的SSID（Active Directory SID）筛选终端，无论其保护状态如何。 `macs` - 数组，用于通过MAC地址列表筛选终端，无论其保护状态如何。 `name` - 字符串，用于按名称筛选端点，无论其保护状态如何。所需最小字符串长度为三个字符。

重要提示

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

字段 name 支持部分匹配。

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

例如：

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

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

可用选项

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

可用选项如下：

章节	描述
`returnProductOutdated`	布尔值。若为 `true` ，则 `productOutdated` 属性将包含在API响应中。
`includeScanLogs`	布尔值。若为true，则 `lastSuccessfulScan` 属性将包含在API响应中。默认值： `false` .

返回值

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

page - 当前页码
pagesCount - 总页数
perPage - 每页返回条目总数
total - 条目总数
items - 包含端点列表的数组。列表中每个条目包含以下字段：
- id ，受管端点的ID，
- name ，端点名称，
- label ，为该端点设置的标签，
- fqdn ，端点的完全限定域名，
- groupId ，端点的组ID，
- isManaged ，布尔值 True ，如果此端点受管理，
- machineType ，机器类型：（1 - 计算机，2 - 虚拟机，3 - EC2实例，0 - 其他），
- operatingSystemVersion ，端点的操作系统版本，
- ip ，端点的IP地址，
- macs ，端点的MAC地址，
- ssid ，端点的SSID（Active Directory SID），
- managedWithBest ，布尔值 True ，如果 BEST 安装在此端点上，
- isContainerHost ，布尔值 True ，如果此端点是容器主机，
- managedExchangeServer ，布尔值 True ，如果此终端是Exchange服务器，
- managedRelay ，布尔值 True ，如果此终端具有中继角色，
- securityServer ，布尔值 True ，如果此终端是安全服务器，
- policy ，一个对象，用于告知终端上生效的策略。该对象包含以下字段：
  - id - 唯一标识活动策略的字符串，
  - name - 策略的名称，
  - applied - 布尔值，如果策略当前在终端上生效，则设置为True，
movingInfo ，一个对象，用于告知终端从一个公司转移到另一个公司的情况。该对象包含：
- state - 终端转移状态（0 - 进行中，1 - 已转移），
- destinationCompanyName - 终端转移到的公司名称。
productOutdated ，布尔值 True ，如果终端缺少一个或多个代理更新。
lastSuccessfulScan ，对象。包含以下详细信息：
- 名称 - 扫描的名称。
- 日期 - 执行扫描的日期。

示例

请求 :

{
      "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,"machineType": 1,"operatingSystemVersion": "Windows 7 专业版",
        "ip": "231.180.244.114",
        "macs": [
          "00:16:3e:7f:d3:2e"
        ],
        "ssid": "","managedWithBest": true,
        "policy": {
          "id": "64b76bed92f0176fa203b64c",
          "name": "新策略",
          "applied": false
        },"productOutdated": false,
        "lastSuccessfulScan": {
          "name": "72OHI5dnIH",
          "date": "2023-07-19T04:09:29+00:00"
        }
      }
    ]
  },
  "jsonrpc": "2.0",
  "id": "5986",
  "error": null
}

获取终端列表

重要提示

参数

注意

可用筛选器

重要提示

可选参数

返回值

注意

注意

示例

版本 1.0

参数

注意

可用过滤器

重要提示

可用选项

返回值

示例

搜索结果