跳至主内容

获取网络清单项

此方法返回网络清单项目。

重要提示

此方法已更新至1.1版本。关于1.0版本的适用信息，请参阅 本节内容 .

参数

参数

类型

是否可选

描述

parentId

字符串

是

目标公司或组的ID。若未指定，则应用默认值。

默认值：发起请求所用API密钥所属公司的ID。

filters

对象

是

查询端点列表时希望使用的筛选条件。

完整可用筛选条件列表及使用说明请查阅 可用筛选条件 .

page

数字

是

结果页码。

默认页码为1。

perPage

数字

是

每页返回条目数。可选值： 1 - 1000 .

默认值： 30 每页显示条目数。

选项

对象

是

使用此选项集来控制请求中包含哪些信息。

更多信息请参阅 可用选项 .

可用选项

您可通过 选项 参数控制响应中返回的数据内容。

章节

子章节

可选

选项

公司

是

  • returnAllProducts - 若设为 true ，响应中将同时包含指定公司的所有产品信息。

    默认值： False .

  • includeRiskScore - 若设为 true ，响应中将包含与各公司关联的风险评分信息。

    默认值： False .

端点

是

  • returnProductOutdated - 若为 true ，则响应中将包含指定公司所有端点的更新状态信息。此参数为可选。

    默认值： False .

  • includeScanLogs - 若为true，则API响应中将包含 lastSuccessfulScan 属性。

    默认值： false .

  • includeRiskScore - 若为 true ，则响应中还将包含与单个端点公司相关的风险评分信息。

    默认值： False .

可用筛选器

章节

子章节

筛选选项

类型

  • 群组 - 布尔值，用于筛选所有自定义终端群组。默认值： False .

  • ec2实例 - 布尔值，用于筛选所有亚马逊EC2实例。默认值： False .

  • 计算机 - 布尔值，用于筛选所有计算机。默认值： False .

  • 虚拟机 - 布尔值，用于筛选所有虚拟机。默认值： False .

安全

管理

  • 最佳管理 - 布尔值，用于筛选所有安装了安全代理的终端。默认值： False .

  • 容器主机 - 布尔值，用于筛选所有安装了容器主机保护的终端。默认值： False .

    此筛选器适用于 计算机 及 虚拟机 服务。

  • 受管理的Exchange服务器 - 布尔值，用于筛选所有受保护的Exchange服务器。默认值： False .

    此筛选器需要覆盖安全服务的有效许可证密钥。

  • 受管理中继 - 布尔值，用于筛选所有具有中继角色的端点。默认值： False .

  • 安全服务器 - 布尔值，用于筛选所有安全服务器。默认值： False .

深度

  • 所有项目递归 - 布尔值，用于在公司网络清单中递归筛选所有端点。默认值： False .

详细信息

  • SSID - 字符串，用于筛选端点的SSID（端点的Active Directory SID），无论其保护状态如何。

  • MAC地址 - 数组，用于筛选端点的MAC地址列表，无论其保护状态如何。

  • 名称 - 字符串，用于按名称筛选项目。所需最小字符串长度为三个字符。

重要

某些筛选器需要激活特定许可证，否则将被忽略，导致API响应不准确。

该字段 名称 支持部分匹配。

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

例如：

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

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

返回值

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

  • page - 当前显示的页码。

  • pagesCount - 总页数（仅在第一页结果中显示）。

  • perPage - 每页返回的条目总数。

  • total - 条目总数（仅在第一页结果中显示）。

  • hasMoreRecords - 布尔值，指示是否还有更多结果页可用。

  • items - 包含项目列表的数组。列表中每个条目包含以下字段：

    • id ，网络项目的ID。

    • name ，网络项目的名称。

    • parentId ，父容器的ID。

    • companyId ，母公司的ID。

    • type ，网络项目的类型： 1 - 公司, 2 - 根容器（公司和网络容器）, 3 - 公司文件夹, 4 - 群组, 5 - 计算机, 6 - 虚拟机, 7 - EC2实例, 14 - 容器组, 15 - 容器主机文件夹, 16 - 容器。

    • 详情 ，关于该项目的更多信息。此字段适用于 1 - 公司， 5 - 计算机， 6 - 虚拟机， 7 - EC2 实例及 16 - 容器。

      有关详情成员内容的详细信息，请参阅 详情成员 .

详情成员

某些网络库存项目包含一个 详情 成员。该成员提供了关于该项目的更多信息，具体信息取决于项目类型。

项目类型

详情

5（计算机）、6（虚拟机）和7（EC2实例）

  • 标签 ，设置给端点的标签

  • FQDN ，端点的完全限定域名

  • 组ID ，端点的组ID

  • isManaged ，布尔值 True ，如果此终端受管理

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

  • operatingSystemVersion ，终端的操作系统版本

  • ip ，终端的IP地址

  • macs ，终端的MAC地址列表

  • 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 ，终端迁入的目标公司名称

  • modules - 包含已安装模块及其状态信息的对象。各字段值为布尔类型 True - 若该模块已启用，或 False - 若该模块已禁用。可用字段包括:

    • advancedThreatControl

    • antimalware

    • contentControl

    • deviceControl

    • firewall

    • powerUser

    • encryption

    • edrSensor

    • hyperDetect

    • patchManagement

    • relay

    • sandboxAnalyzer

    • exchange

    • advancedAntiExploit

    • containerProtection

    • networkAttackDefense

    • integrityMonitoring

  • productOutdated - 布尔值，表示单个终端上的安全代理是否为最新版本。可能取值:

    • true ，表示终端部署的代理为最新版本。

    • false ，表示终端未安装最新版代理。

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

    • name - 扫描名称。

    • date - 执行扫描的日期。

  • riskScore - 包含端点安全风险信息的对象：

    • value ，端点安全风险评分值（百分比），分为配置错误和应用漏洞两部分

    • impact ，端点安全风险影响等级（低、中、高）

    • misconfigurations ，配置错误在端点安全风险评分中的占比（百分比）

    • appVulnerabilities ，应用漏洞在端点安全风险评分中的占比（百分比）

    • humanRisks ，人为风险在端点安全风险评分中的占比（百分比）

示例

请求 : 

{
       "params": {
           "parentId": "23b19c39b1a43d89367b32ce",
           "page": 1,
           "perPage": 1,
           "filters": {
               "type": {
                   "computers": true
               },
               "depth": {
                   "allItemsRecursively": true
               }
           },
           "options": {
               "companies": {
                   "returnAllProducts": true,
                   "includeRiskScore": true
               },
               "endpoints": {
                   "returnProductOutdated": true,
                   "includeScanLogs": true,
                   "includeRiskScore": true
               }
           }
       },
       "jsonrpc": "2.0",
       "method": "getNetworkInventoryItems",
       "id": "301f7b05-ec02-481b-9ed6-c07b97de2b7b"
  }

响应 : 

{
  "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": {
            "高级威胁防护": false,
            "反恶意软件": true,
            "内容控制": false,
            "设备控制": false,
            "防火墙": false,
            "高级用户": false,
            "网络攻击防护": false
          },
          "ssid": ""
        }
      }
    ]
  }
}
{
  "result": {
    "page": 2,
    "perPage": 3,
    "hasMoreRecords": true,
    "items": [
      "...": "..."
    ]
}

版本1.0

参数

参数

类型

可选

描述

parentId

字符串

是

目标公司或集团的ID。若未指定，则返回与API密钥关联公司的目标项目。

筛选器

对象

是

查询端点列表时使用的筛选条件。关于可用筛选器及其使用方法，请参阅 可用筛选器 .

页码

数字

是

结果页码。默认页码为1。

每页条数

数字

是

每页返回的项目数量。上限为每页100项。默认值：每页30项。

选项

对象

是

用于控制请求中包含信息的一组选项。关于可用选项及其使用方法，请参阅 可用选项 .

可用选项

您可以使用 选项 参数来控制响应中返回的数据。

章节

子章节

选项

公司

  • returnAllProducts - 如果 true ，响应中将包含给定公司所有产品的信息。此参数可选，默认值： False .

端点

  • returnProductOutdated - 如果 true ，响应中将包含给定公司所有端点的更新状态信息。此参数可选，默认值： False .

  • includeScanLogs - 若为true，则 lastSuccessfulScan 属性将包含在API响应中。此参数可选，默认值： false .

可用筛选器

章节

子章节

筛选选项

类型

  • 组 - 布尔值，用于筛选所有自定义端点组。默认值： False .

  • ec2Instances - 一个布尔值，用于筛选所有亚马逊EC2实例。默认值： False .

  • computers - 一个布尔值，用于筛选所有计算机。默认值： False .

  • virtualMachines - 一个布尔值，用于筛选所有虚拟机。默认值： False .

security

management

  • managedWithBest - 一个布尔值，用于筛选所有已安装安全代理的终端。默认值： False .

  • isContainerHost - 一个布尔值，用于筛选所有已安装容器主机保护的终端。默认值： False .

    此筛选器适用于 计算机 和 虚拟机 服务。

  • managedExchangeServers - 一个布尔值，用于筛选所有受保护的Exchange服务器。默认值： False .

    该筛选器需要覆盖安全服务的有效许可证密钥。

  • managedRelays - 布尔值，用于筛选所有具有中继角色的终端。默认值： False .

  • securityServers - 布尔值，用于筛选所有安全服务器。默认值： 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，

    • companyId ，母公司ID，

    • type ，网络项类型： 1 - 公司， 2 - 根容器（公司及网络容器）， 3 - 公司文件夹， 4 - 组， 5 - 计算机， 6 - 虚拟机， 7 - EC2实例， 14 - 容器组， 15 - 容器主机文件夹， 16 - 容器。

    • details ，关于该项的更多信息。该字段适用于 1 - 公司， 5 - 计算机， 6 - 虚拟机, 7 - EC2实例和 16 - 容器。有关details成员内容的详细信息，请参阅 details成员 .

details成员

部分网络清单项包含一个 details 成员。该成员会展示关于该项的更多信息，具体信息取决于项的类型。

项类型

详情

5(计算机)、6(虚拟机)和7(EC2实例)

  • label ，终端节点设置的标签

  • fqdn ，终端节点的完全限定域名

  • groupId ，终端节点的组ID

  • isManaged ，布尔值 True ，表示该终端节点受管理

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

  • operatingSystemVersion , 终端设备的操作系统版本

  • ip , 终端设备的IP地址

  • macs , 终端设备的MAC地址列表

  • ssid , 终端设备的Active Directory SID

  • managedWithBest , 布尔值 True , 如果 BEST 已安装在此终端设备上

  • isContainerHost , 布尔值 True , 如果此终端设备是容器主机

  • managedExchangeServer , 布尔值 True , 如果此终端设备是Exchange服务器

  • managedRelay , 布尔值 True ，若此终端具有中继角色

  • 安全服务器 ，布尔值 真 ，若此终端为安全服务器

  • 策略 - 包含终端当前生效策略信息的对象。该对象包含以下字段：

    • 标识符 ，唯一标识当前策略的字符串

    • 名称 ，策略名称

    • 已应用 ，布尔值，若策略当前已应用于终端则设为真

  • 迁移信息 - 包含终端从某公司迁移至另一公司状态信息的对象。该对象包含：

    • 状态 ，终端迁移状态（0-进行中，1-已完成）

    • 目标公司名称 ，终端所迁移至的公司名称

  • 模块 - 包含已安装模块及其状态信息的对象。各字段为布尔值， 真 表示模块已启用， 假 表示模块已禁用。可用字段包括：

    • 高级威胁防护

    • 反恶意软件

    • 内容控制

    • 设备控制

    • 防火墙

    • 高级用户

    • 加密

    • 终端检测与响应传感器

    • HyperDetect

    • 补丁管理

    • 中继

    • 沙箱分析器

    • 交换

    • 高级漏洞利用防护

    • 容器保护

    • 网络攻击防护

    • 完整性监控

  • 产品过时 - 布尔值，用于指定单个终端上的安全代理是否为最新版本。可能取值：

    • true ，表示终端部署的代理为最新版本。

    • false ，表示终端未安装最新版代理。

  • 上次成功扫描 ，对象。包含以下详细信息：

    • 名称 - 扫描任务的名称。

    • 日期 - 执行扫描的日期。

示例

请求 : 

{
       "params": {
           "parentId": "23b19c39b1a43d89367b32ce",
           "page": 1,
           "perPage": 1,
           "filters": {
               "type": {
                   "computers": true
               },
               "depth": {
                   "allItemsRecursively": true
               }
           },
           "options": {
               "companies": {
                   "returnAllProducts": true
               },
               "endpoints": {
                   "returnProductOutdated": true,
                   "includeScanLogs": true
               }
           }
       },
       "jsonrpc": "2.0",
       "method": "getNetworkInventoryItems",
       "id": "301f7b05-ec02-481b-9ed6-c07b97de2b7b"
  }

响应 : 

{
  "result": {
    "total": 8,
    "page": 1,
    "perPage": 30,
    "pagesCount": 1,
    "items": [
      {
        "id": "64b51d5266333579d804e696",
        "name": "MSPPartner01",
        "type": 1,
        "parentId": "64b503c21ecee42e130a7bc7",
        "companyId": "64b503c21ecee42e130a7bc4",
        "details": {
          "type": 0,
          "address": "",
          "phone": "",
          "industry": 0,
          "canBeManagedByAbove": true,
          "enforce2FA": true,
          "skip2FAPeriod": 0,
          "isSuspended": false,
          "createdAt": "2023-07-17T10:52:02",
          "country": "N/A",
          "state": "N/A",
          "contactPerson": {
            "email": "test@email.com",
            "fullName": "",
            "phoneNumber": "",
            "companyRole": ""
          },
          "mdrContactInformation": {
            "phoneNumber": {
              "countryPrefix": "+4",
              "subscriberNumber": "112345"
            },
            "fullName": "联系人",
            "email": "mdrcontact@nebula.local",
            "emailVerificationCode": "43728676"
          },
          "licenseInfo": {
            "isAddon": false,
            "expiryDate": "2025-04-22T00:00:00",
            "usedSlots": 2,
            "reservedSlots": 0,
            "totalSlots": null,
            "manageExchange": false,
            "manageEncryption": false,
            "manageRemoteEnginesScanning": false,
            "manageHyperDetect": true,
            "managePHASR": true,
            "manageSandboxAnalyzer": true,
            "managePatchManagement": false,
            "manageEventCorrelator": true,
            "manageEmailSecurity": false,
            "manageMobileSecurity": false,
            "manageContainerProtection": false,
            "manageIntegrityMonitoring": false,
            "assignedProtectionModel": "mspSecureExtra",
            "additionalProtectionModels": [
              "aLaCarte",
              "mspSecure",
              "mspSecurePlus",
              "mspSecureExtra"
            ],
            "assignedProductType": 0,
            "additionalProductTypes": [
              0
            ],
            "ownUse": {
              "manageXDRIdentityProviders": true,
              "manageXDRProductivityApps": true,
              "manageXDRNetwork": false,
              "manageXDRCloudWorkloads": false,
              "manageRemoteEnginesScanning": false,
              "manageContainerProtection": false,
              "manageHyperDetect": true,
              "managePHASR": true,
              "manageSandboxAnalyzer": true,
              "manageEventCorrelator": true
            },
            "resell": {
              "manageXDRResell": true,
              "manageRemoteEnginesScanningResell": false,
              "manageContainerProtectionResell": false,
              "manageHyperDetectResell": true,
              "managePHASRResell": true,
              "manageSandboxAnalyzerResell": true,
              "manageEventCorrelatorResell": true
            },
            "licensedServices": {
              "mdrServiceFlavor": 1,
              "mdrServiceStatus": 3,
              "mdrStatusStartDate": "2023-07-17T10:52:03",
              "mdrServiceResell": true
            },
            "subscriptionType": 3
          }
        }
      },
      {
        "id": "64b503c21ecee42e130a7bc9",
        "name": "自定义分组",
        "type": 4,
        "parentId": "64b503c21ecee42e130a7bc4",
        "companyId": "64b503c21ecee42e130a7bc4"
      },
      {
        "id": "64b51d5366333579d804e69c",
        "name": "自定义分组",
        "type": 4,
        "parentId": "64b51d5266333579d804e696",
        "companyId": "64b51d5266333579d804e696"
      },
      {
        "id": "64b76496cc33ea14e43c3c2b",
        "name": "gfdsg00:16:3e:28:ee:fe",
        "type": 5,
        "parentId": "64b51d5366333579d804e69c",
        "companyId": "64b51d5266333579d804e696",
        "details": {
          "label": "",
          "fqdn": "t4x03.mqdhn.dsd.ro",
          "groupId": "64b51d5366333579d804e69c",
          "isManaged": true,
          "machineType": 1,
          "operatingSystemVersion": "Windows 7 专业版",
          "ip": "136.61.135.44",
          "macs": ["00:16:3e:28:ee:fe"],
          "ssid": "",
          "managedWithBest": true,
          "policy": {
            "id": "64b76bed92f0176fa203b64c",
            "name": "新策略",
            "applied": false
          },
          "productOutdated": false
        },
        "lastSuccessfulScan": {
          "name": "tXoRyyCSLn",
          "date": "2023-07-19T04:18:58+00:00"
        }
      },
      {
        "id": "64b51ecd4eea172c5b3f92d1",
        "name": "string00:16:3e:2c:45:da",
        "type": 5,
        "parentId": "64b51d5366333579d804e69c",
        "companyId": "64b51d5266333579d804e696",
        "details": {
          "label": "",
          "fqdn": "fcm0s.oyzqh.dsd.ro",
          "groupId": "64b51d5366333579d804e69c",
          "isManaged": true,
          "machineType": 1,
          "operatingSystemVersion": "Windows 7 专业版",
          "ip": "44.215.154.49",
          "macs": ["00:16:3e:2c:45:da"],
          "ssid": "",
          "managedWithBest": true,
          "policy": {
            "id": "64b76bed92f0176fa203b64c",
            "name": "新策略",
            "applied": false
          },
          "productOutdated": false
        },
        "lastSuccessfulScan": {
          "name": "lJeA5kuIWK",
          "date": "2023-07-17T10:58:05+00:00"
        }
      },
      {
        "id": "64b7625d3c11463ef77e5d6d",
        "name": "string00:16:3e:7f:d3:2e",
        "type": 5,
        "parentId": "64b503c21ecee42e130a7bc9",
        "companyId": "64b503c21ecee42e130a7bc4",
        "details": {
          "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"
        }
      },
      {
        "id": "64b503c21ecee42e130a7bca",
        "name": "已删除",
        "type": 4,
        "parentId": "64b503c21ecee42e130a7bc4",
        "companyId": "64b503c21ecee42e130a7bc4"
      },
      {
        "id": "64b51d5366333579d804e69d",
        "name": "已删除",
        "type": 4,
        "parentId": "64b51d5266333579d804e696",
        "companyId": "64b51d5266333579d804e696"
      }
    ]
  },
  "jsonrpc": "2.0",
  "id": "5986",
  "error": null
}
本节内容 :