获取网络库存项

该方法返回网络库存项。

重要提示

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

参数

参数	类型	可选	描述
`父级ID`	字符串	是	目标公司或集团的ID。若未指定，则应用默认值。默认值：发起请求所用API密钥所属公司的ID。
`筛选器`	对象	是	查询端点列表时希望使用的筛选条件。完整筛选器列表及使用说明请参见可用筛选器 .
`页码`	数字	是	结果页码。默认页码为1。
`每页条数`	数字	是	每页返回的条目数。可选值： `1` - `1000` . 默认值： `30` 条/页。
`选项`	对象	是	使用这组选项来控制请求中包含哪些信息。更多信息，请参阅可用选项 .

可用选项

您可以使用 options 参数来控制响应中返回哪些数据。

章节	小节	可选	选项
`companies`		是	`returnAllProducts` - 如果 `true` ，则给定公司的所有产品信息也将包含在响应中。默认值： `False` . `includeRiskScore` - 如果 `true` ，则与个别公司相关的风险评分信息也将包含在响应中。默认值： `False` .
`endpoints`		是	`returnProductOutdated` - 如果 `true` ，响应中将包含给定公司所有终端更新状态的信息。此参数为可选。默认值： `False` . `includeScanLogs` - 若为true，则 `lastSuccessfulScan` 属性将包含在API响应中。默认值： `false` . `includeRiskScore` - 若 `true` ，响应中还将包含与单个终端公司相关的风险评分信息。默认值： `False` .

可用筛选器

章节	子章节	筛选选项
`type`		`companies` - 布尔值，用于筛选所有公司。默认值： `False` . `companyFolders` - 一个布尔值，用于筛选所有包含公司的文件夹。默认值： `False` . `groups` - 一个布尔值，用于筛选所有自定义终端组。默认值： `False` . `ec2Instances` - 一个布尔值，用于筛选所有亚马逊EC2实例。默认值： `False` . `computers` - 一个布尔值，用于筛选所有计算机。默认值： `False` . `virtualMachines` - 一个布尔值，用于筛选所有虚拟机。默认值： `False` .
`security`	management	`managedWithBest` - 一个布尔值，用于筛选所有安装了安全代理的终端。默认值： `False` . `isContainerHost` - 一个布尔值，用于筛选所有安装了容器主机保护的终端。默认值： `False` . 该筛选器适用于 `计算机` 及 `虚拟机` 服务。 `受管Exchange服务器` - 布尔值，用于筛选所有受保护的Exchange服务器。默认值： `否` . 此筛选器需要覆盖安全服务的有效许可证密钥。 `受管中继` - 布尔值，用于筛选所有具有中继角色的终端。默认值： `否` . `安全服务器` - 布尔值，用于筛选所有安全服务器。默认值： `否` .
`深度`		`递归所有项目` - 布尔值，用于递归筛选公司网络清单中的所有终端。默认值： `否` .
`详细信息`		`SSID` - 字符串，用于根据终端SSID（Active Directory SID）筛选终端，无论其保护状态如何。 `MAC地址` - 数组，用于根据MAC地址列表筛选终端，无论其保护状态如何。 `订阅类型` - 整数数组，表示用于筛选公司的许可证订阅类型列表： `1` - 试用许可证的公司， `2` - 年度许可证的公司及拥有按月计费许可证密钥的合作伙伴公司， `3` - 按月订阅的公司， `4` - 按月试用许可证的公司， `5` - 按月订阅试用的公司 `companyType` - 一个整数，用于根据公司与Bitdefender的关系筛选公司： `0` - 合作伙伴公司， `1` - 客户公司 `name` - 用于按名称筛选项目的字符串。最小字符串长度为三个字符。

重要提示

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

字段 name 支持部分匹配。

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

例如：

若 name 为 computer ，则API将返回所有名称以 计算机 .

如果 名称 是 *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 - 容器。
- details ，关于该项的更多信息。该字段适用于 1 - 公司, 5 - 计算机, 6 - 虚拟机， 7 - EC2 实例及 16 - 容器。
  
  有关 details 成员内容的详细信息，请参阅 details 成员 .

details 成员

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

项目类型	详细信息
`1（公司）`	`type` - 公司类型：0 表示合作伙伴，1 表示客户 `address` - 公司的实际地址 `phone` - 公司的电话号码 `canBeManagedByAbove` - 布尔值，表示合作伙伴是否可以管理该公司的安全性 `isSuspended` - 布尔值，表示公司账户是否被暂停 `createdAt` - 字符串，表示公司创建的 UTC 日期和时间 `licenseInfo` - 对象，包含公司许可证订阅的信息： `subscriptionType` - 公司的订阅类型： `1` 表示试用订阅， `2` 表示许可订阅， `3` 表示月度订阅， `4` 表示月度许可试用， `5` 表示月度订阅试用， `6` 表示FRAT订阅。 `riskScore` - 包含公司安全风险相关信息的对象： `value` ，公司安全风险评分值（百分比），由错误配置、应用漏洞、人为风险构成，并经过健康行业修正因子调整 `impact` ，公司安全风险影响等级（低、中、高） `misconfigurations` ，错误配置在公司安全风险评分中的占比 `appVulnerabilities` ，应用漏洞在公司安全风险评分中的占比 `humanRisks` ，人为风险在公司安全风险评分中的占比 `industryModifier` ，根据环境中发现的、已在行业层面被利用的CVE动态调整公司评分 `isAddon` - 该产品是否为附加组件 `expiryDate` - 许可证到期日期 `usedSlots` - 已使用的席位数量 `totalSlots` - 授权订阅的总席位数量，或从母公司继承月度许可证的子公司的预留席位数量。 `licenseKey` - 试用版或授权订阅的许可证密钥。 `endSubscription` - 订阅结束日期。此选项适用于按月订阅的公司。 `autoRenewPeriod` - 订阅自动续订周期（以月为单位）。此选项适用于按月订阅的公司。 `manageExchange` - 如果公司被允许管理Exchange安全功能，则为True，否则为False `manageEncryption` - 如果公司被允许管理全盘加密功能，则为True，否则为False `manageRemoteEnginesScanning` - 如果公司被允许管理虚拟化环境安全功能，则为True，否则为False 注意如果存在以下任一情况，则不能使用此参数 `manageRemoteEnginesScanning` 和 `manageRemoteEnginesScanningResell` 设置，位于 `ownUse` 和 `resell` 对象参数下。 `manageHyperDetect` - 如果公司被允许管理HyperDetect功能，则为True，否则为False `manageSandboxAnalyzer` - 如果公司被允许管理沙箱分析器功能则为True，否则为False `managePatchManagement` - 如果公司被允许管理补丁管理功能则为True，否则为False `manageEventCorrelator` - 如果公司被允许管理终端检测与响应功能则为True，否则为False `manageEmailSecurity` - 如果公司被允许管理邮件安全功能则为True，否则为False `manageMobileSecurity` - 如果公司被允许管理移动安全功能则为True，否则为False `manageContainerProtection` - 如果公司被允许管理容器保护功能则为True，否则为False 注意若存在以下任一情况，则不能使用此参数： `manageContainerProtection` 与 `manageContainerProtectionResell` 设置位于 `ownUse` 和 `resell` 对象参数下。 `manageIntegrityMonitoring` - 如果公司被允许管理完整性监控功能则为True，否则为False `manageComplianceManager` - 如果公司被允许管理合规管理器功能则为True，否则为False `imDataRetention` - 表示事件存储天数的整数值。仅当 `manageIntegrityMonitoring` 为 `true时返回` 可选值： `0` （7天保留期）, `1` （90天保留期）, `2` （180天保留期）, `3` （1年保留期）。 `ownUse` ，包含公司服务及附加功能激活设置的对象。 `manageXDRIdentityProviders` ，布尔值，指定公司是否被允许在传感器管理中激活Azure AD和Active Directory集成。 `manageXDRProductivityApps` ，布尔值，指定公司是否被允许在传感器管理中激活Office 365集成。 `manageXDRNetwork` ，布尔值，指定公司是否被允许在传感器管理中激活网络传感器集成。 `manageXDRCloudWorkloads` ，布尔值，指定公司是否被允许在传感器管理中激活AWS集成。注意若以下任一参数 `manageXDRIdentityProviders` , `manageXDRProductivityApps` , `manageXDRNetwork` 或 `manageXDRCloudWorkloads` 设为true， `XDR` 已为公司激活。 `manageRemoteEnginesScanning` ，可选参数，表示是否为您的公司激活虚拟化环境安全功能。可选值： `true` 或 `false` 。默认值： `false` . `manageEventCorrelator` ，可选参数，表示是否为您的公司激活端点检测与响应（EDR）功能。可选值： `true` 或 `false` 。默认值： `false` . `manageSandboxAnalyzer` ，可选参数，表示是否为您的公司激活沙箱分析器功能。可选值： `true` 或 `false` 。默认值： `false` . `manageHyperDetect` ，可选参数，表示是否为您的公司激活HyperDetect功能。可选值： `true` 或 `false` 。默认值： `false` . `managePHASR` ，可选参数，表示是否为您的公司启用PHASR。可选值： `true` 或 `false` 。默认值： `false` . `manageEASM` ，可选参数，表示是否为您的公司启用EASM。可选值： `true` 或 `false` 。默认值： `false` . `manageComplianceManager` ，可选参数，表示是否为您的公司启用Compliance Manager附加功能。可选值： `true` 或 `false` 。默认值： `false` . 该参数仅在 `subscriptionType` 取以下值时返回： `3` ，表示按月订阅 `5` ，表示按月订阅试用 `resell` ，一个包含公司服务和附加组件转售设置的对象。 `manageXDRResell` ——布尔值，指定公司是否被允许向客户销售扩展检测与响应服务。 `manageRemoteEnginesScanningResell` ，可选，表示公司是否可以向其客户销售虚拟化环境安全服务。可能取值： `true` 或 `false` 。默认值： `false` . `manageEventCorrelatorResell` ，可选，表示公司是否可以向其客户销售端点检测与响应（EDR）服务。可能取值： `true` 或 `false` 。默认值： `false` . `manageSandboxAnalyzerResell` ，可选，表示公司是否可以向其客户销售沙箱分析器。可能取值： `true` 或 `false` 。默认值： `false` . `manageHyperDetectResell` ，可选参数，表示公司是否可向客户销售HyperDetect。可选值： `true` 或 `false` 。默认值： `false` . `managePHASRResell` ，可选参数，表示公司是否可向客户销售PHASR。可选值： `true` 或 `false` 。默认值： `false` . `manageEASMResell` ，可选参数，表示公司是否可向客户销售EASM。可选值： `true` 或 `false` 。默认值： `false` . `manageComplianceManagerResell` ，可选参数，表示公司是否可向客户转售Compliance Manager附加组件。可选值： `true` 或 `false` 。默认值： `false` . 仅当 `subscriptionType` 为以下值时返回该参数： `3` （月度订阅） `5` （月度订阅试用） `edrDataRetention` ，表示公司是否启用EDR数据保留功能及数据存储时长的整数值。可选值： `0` - 未启用数据保留 `1` - 启用90天数据保留 `2` - 启用180天数据保留 `3` - 启用1年数据保留该参数仅在以下情况返回： `manageEventCorrelator` 参数包含于请求且设为 `true` ，或当 `assignedProtectionModel` 参数设为 `mspSecure` , `mspSecurePlus` 或 `mspSecureExtra` . `licensedServices` ，一个包含公司服务设置的对象。 `mdrServiceFlavor` ，一个整数，表示公司自用的MDR服务类型。可能的值： `1` 表示基础版。如果公司没有自用的MDR服务，则此参数缺失。 `mdrServiceStatus` ，一个整数，表示MDR服务状态。可能的值： `1` 表示活跃， `2` 表示非活跃， `3` 表示正在启用， `4` 表示正在切换， `5` 表示正在禁用。如果公司没有自用的MDR服务，则此参数缺失。 `mdrStatusStartDate` ，服务开始日期。如果公司没有自用的MDR服务，则此参数缺失。 `mdrServiceResell` ，一个布尔值，指定公司是否被允许向其创建的公司转售MDR服务。 `minimumUsage` - 一个对象，包含许可证类型及公司通过法律协议承诺每月使用的最小插槽数： `endpointMonthlyUsage` ，客户同意从主许可证中使用的最小端点数量。 `assignedProductType` - 分配给公司的产品类型： `0` ，表示终端安全 `3` ，表示Bitdefender EDR 该参数仅在subscriptionType取以下值时返回： `3` ，表示月度订阅 `5` ，表示月度订阅试用 `additionalProductTypes` - 可分配给子公司的产品类型数组： `0` ，表示终端安全 `3` ，表示Bitdefender EDR 该参数仅在 `subscriptionType` 取以下值时返回： `3` ，表示月度订阅 `5` ，表示月度订阅试用 `assignedProtectionModel` - 表示公司将使用的保护模型类型的字符串。 `aLaCarte` `mspSecure` `mspSecurePlus` `mspSecureExtra` 仅当满足以下所有条件时才会返回此参数： `type` = `3` (月度安全) `assignedProductType` = `0` (终端安全) `additionalProtectionModels` - 表示保护模型类型的字符串数组。该参数允许合作伙伴公司为其客户分配除 `assignedProtectionModel` 对象提供的保护模型之外的额外保护模型。 `aLaCarte` `mspSecure` `mspSecurePlus` `mspSecureExtra` 满足以下任一条件时将返回此参数： `assignedProductType` = `3` (Bitdefender EDR), `additionalProductType` 必须包含 `0` (终端安全), 且 `type` = `3` (月度安全)。 `assignedProductType` = `0` (终端安全), `type` = `3` (月度订阅). `reservedSlots` - 为子公司预留的总席位数量。此选项适用于采用月度许可的合作伙伴公司。 additionalLicenses - 仅当公司分配了多个产品（附加组件或基础许可证）时出现。包含关于附加组件及分配给该公司的主许可证信息的数组： `expiryDate` ，许可证到期日期。若产品为附加组件，则此信息不可用。 `usedSlots` ，已使用的席位数量。若产品为附加组件，仅当附加组件类型为"邮件安全"时此信息可用。 `licenseKey` ，试用版或授权订阅的许可证密钥。 `isAddon` ，标识产品是否为附加组件或基础许可证 `country` - 表示国家代码的字符串，格式为 ISO 3166 。若未指定代码，则字符串值为 `N/A` `state` - 表示国家行政区代码的字符串，格式为 ISO 3166 。若未指定代码，则字符串值为 `N/A` `contactPerson` - 一个包含联系人详细信息的对象： `fullName` ，其名字和姓氏 `email` ，其业务电子邮件地址 `phoneNumber` ，其业务电话号码 `companyRole` ，其在公司的职位 `mdrContactInformation` - 一个包含MDR联系人详细信息的对象： `fullName` ，其名字和姓氏 `email` ，其业务电子邮件地址 `phoneNumber` ，其业务电话号码 `customFields` - 一个包含公司自定义字段值的对象： `自定义字段名称1` ，自定义字段值1 `自定义字段名称2` ，自定义字段值2
`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` ，若此终端具有中继角色 `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` ，人为风险在端点安全风险评分中的占比

项目类型

详细信息

1（公司）

type - 公司类型：0 表示合作伙伴，1 表示客户
address - 公司的实际地址
phone - 公司的电话号码
canBeManagedByAbove - 布尔值，表示合作伙伴是否可以管理该公司的安全性
isSuspended - 布尔值，表示公司账户是否被暂停
createdAt - 字符串，表示公司创建的 UTC 日期和时间
licenseInfo - 对象，包含公司许可证订阅的信息：
- subscriptionType - 公司的订阅类型： 1 表示试用订阅， 2 表示许可订阅， 3 表示月度订阅， 4 表示月度许可试用， 5 表示月度订阅试用， 6 表示FRAT订阅。
- riskScore - 包含公司安全风险相关信息的对象：
  - value ，公司安全风险评分值（百分比），由错误配置、应用漏洞、人为风险构成，并经过健康行业修正因子调整
  - impact ，公司安全风险影响等级（低、中、高）
  - misconfigurations ，错误配置在公司安全风险评分中的占比
  - appVulnerabilities ，应用漏洞在公司安全风险评分中的占比
  - humanRisks ，人为风险在公司安全风险评分中的占比
  - industryModifier ，根据环境中发现的、已在行业层面被利用的CVE动态调整公司评分
- isAddon - 该产品是否为附加组件
- expiryDate - 许可证到期日期
- usedSlots - 已使用的席位数量
- totalSlots - 授权订阅的总席位数量，或从母公司继承月度许可证的子公司的预留席位数量。
- licenseKey - 试用版或授权订阅的许可证密钥。
- endSubscription - 订阅结束日期。此选项适用于按月订阅的公司。
- autoRenewPeriod - 订阅自动续订周期（以月为单位）。此选项适用于按月订阅的公司。
- manageExchange - 如果公司被允许管理Exchange安全功能，则为True，否则为False
- manageEncryption - 如果公司被允许管理全盘加密功能，则为True，否则为False
- manageRemoteEnginesScanning - 如果公司被允许管理虚拟化环境安全功能，则为True，否则为False
  
  注意
  
  如果存在以下任一情况，则不能使用此参数 manageRemoteEnginesScanning 和 manageRemoteEnginesScanningResell 设置，位于 ownUse 和 resell 对象参数下。
- manageHyperDetect - 如果公司被允许管理HyperDetect功能，则为True，否则为False
- manageSandboxAnalyzer - 如果公司被允许管理沙箱分析器功能则为True，否则为False
- managePatchManagement - 如果公司被允许管理补丁管理功能则为True，否则为False
- manageEventCorrelator - 如果公司被允许管理终端检测与响应功能则为True，否则为False
- manageEmailSecurity - 如果公司被允许管理邮件安全功能则为True，否则为False
- manageMobileSecurity - 如果公司被允许管理移动安全功能则为True，否则为False
- manageContainerProtection - 如果公司被允许管理容器保护功能则为True，否则为False
  
  注意
  
  若存在以下任一情况，则不能使用此参数： manageContainerProtection 与 manageContainerProtectionResell 设置位于 ownUse 和 resell 对象参数下。
- manageIntegrityMonitoring - 如果公司被允许管理完整性监控功能则为True，否则为False
- manageComplianceManager - 如果公司被允许管理合规管理器功能则为True，否则为False
- imDataRetention - 表示事件存储天数的整数值。仅当 manageIntegrityMonitoring 为 true时返回 可选值： 0 （7天保留期）, 1 （90天保留期）, 2 （180天保留期）, 3 （1年保留期）。
- ownUse ，包含公司服务及附加功能激活设置的对象。
  - manageXDRIdentityProviders ，布尔值，指定公司是否被允许在传感器管理中激活Azure AD和Active Directory集成。
  - manageXDRProductivityApps ，布尔值，指定公司是否被允许在传感器管理中激活Office 365集成。
  - manageXDRNetwork ，布尔值，指定公司是否被允许在传感器管理中激活网络传感器集成。
  - manageXDRCloudWorkloads ，布尔值，指定公司是否被允许在传感器管理中激活AWS集成。
    
    注意
    
    若以下任一参数 manageXDRIdentityProviders , manageXDRProductivityApps , manageXDRNetwork 或 manageXDRCloudWorkloads 设为true， XDR 已为公司激活。
  - manageRemoteEnginesScanning ，可选参数，表示是否为您的公司激活虚拟化环境安全功能。可选值： true 或 false 。默认值： false .
  - manageEventCorrelator ，可选参数，表示是否为您的公司激活端点检测与响应（EDR）功能。可选值： true 或 false 。默认值： false .
  - manageSandboxAnalyzer ，可选参数，表示是否为您的公司激活沙箱分析器功能。可选值： true 或 false 。默认值： false .
  - manageHyperDetect ，可选参数，表示是否为您的公司激活HyperDetect功能。可选值： true 或 false 。默认值： false .
  - managePHASR ，可选参数，表示是否为您的公司启用PHASR。可选值： true 或 false 。默认值： false .
  - manageEASM ，可选参数，表示是否为您的公司启用EASM。可选值： true 或 false 。默认值： false .
  - manageComplianceManager ，可选参数，表示是否为您的公司启用Compliance Manager附加功能。可选值： true 或 false 。默认值： false .
  该参数仅在 subscriptionType 取以下值时返回：
  - 3 ，表示按月订阅
  - 5 ，表示按月订阅试用
- resell ，一个包含公司服务和附加组件转售设置的对象。
  - manageXDRResell ——布尔值，指定公司是否被允许向客户销售扩展检测与响应服务。
  - manageRemoteEnginesScanningResell ，可选，表示公司是否可以向其客户销售虚拟化环境安全服务。可能取值： true 或 false 。默认值： false .
  - manageEventCorrelatorResell ，可选，表示公司是否可以向其客户销售端点检测与响应（EDR）服务。可能取值： true 或 false 。默认值： false .
  - manageSandboxAnalyzerResell ，可选，表示公司是否可以向其客户销售沙箱分析器。可能取值： true 或 false 。默认值： false .
  - manageHyperDetectResell ，可选参数，表示公司是否可向客户销售HyperDetect。可选值： true 或 false 。默认值： false .
  - managePHASRResell ，可选参数，表示公司是否可向客户销售PHASR。可选值： true 或 false 。默认值： false .
  - manageEASMResell ，可选参数，表示公司是否可向客户销售EASM。可选值： true 或 false 。默认值： false .
  - manageComplianceManagerResell ，可选参数，表示公司是否可向客户转售Compliance Manager附加组件。可选值： true 或 false 。默认值： false .
  仅当 subscriptionType 为以下值时返回该参数：
  - 3 （月度订阅）
  - 5 （月度订阅试用）
- edrDataRetention ，表示公司是否启用EDR数据保留功能及数据存储时长的整数值。可选值：
  - 0 - 未启用数据保留
  - 1 - 启用90天数据保留
  - 2 - 启用180天数据保留
  - 3 - 启用1年数据保留
  该参数仅在以下情况返回： manageEventCorrelator 参数包含于请求且设为 true ，或当 assignedProtectionModel 参数设为 mspSecure , mspSecurePlus 或 mspSecureExtra .
- licensedServices ，一个包含公司服务设置的对象。
  - mdrServiceFlavor ，一个整数，表示公司自用的MDR服务类型。可能的值： 1 表示基础版。如果公司没有自用的MDR服务，则此参数缺失。
  - mdrServiceStatus ，一个整数，表示MDR服务状态。可能的值： 1 表示活跃， 2 表示非活跃， 3 表示正在启用， 4 表示正在切换， 5 表示正在禁用。如果公司没有自用的MDR服务，则此参数缺失。
  - mdrStatusStartDate ，服务开始日期。如果公司没有自用的MDR服务，则此参数缺失。
  - mdrServiceResell ，一个布尔值，指定公司是否被允许向其创建的公司转售MDR服务。
- minimumUsage - 一个对象，包含许可证类型及公司通过法律协议承诺每月使用的最小插槽数：
  - endpointMonthlyUsage ，客户同意从主许可证中使用的最小端点数量。
- assignedProductType - 分配给公司的产品类型：
  - 0 ，表示终端安全
  - 3 ，表示Bitdefender EDR
  该参数仅在subscriptionType取以下值时返回：
  - 3 ，表示月度订阅
  - 5 ，表示月度订阅试用
- additionalProductTypes - 可分配给子公司的产品类型数组：
  - 0 ，表示终端安全
  - 3 ，表示Bitdefender EDR
  该参数仅在 subscriptionType 取以下值时返回：
  - 3 ，表示月度订阅
  - 5 ，表示月度订阅试用
- assignedProtectionModel - 表示公司将使用的保护模型类型的字符串。
  - aLaCarte
  - mspSecure
  - mspSecurePlus
  - mspSecureExtra
  仅当满足以下所有条件时才会返回此参数：
  - type = 3 (月度安全)
  - assignedProductType = 0 (终端安全)
- additionalProtectionModels - 表示保护模型类型的字符串数组。该参数允许合作伙伴公司为其客户分配除 assignedProtectionModel 对象提供的保护模型之外的额外保护模型。
  - aLaCarte
  - mspSecure
  - mspSecurePlus
  - mspSecureExtra
  满足以下任一条件时将返回此参数：
  - assignedProductType = 3 (Bitdefender EDR), additionalProductType 必须包含 0 (终端安全), 且 type = 3 (月度安全)。
  - assignedProductType = 0 (终端安全), type = 3 (月度订阅).
- reservedSlots - 为子公司预留的总席位数量。此选项适用于采用月度许可的合作伙伴公司。
- additionalLicenses - 仅当公司分配了多个产品（附加组件或基础许可证）时出现。包含关于附加组件及分配给该公司的主许可证信息的数组：
  - expiryDate ，许可证到期日期。若产品为附加组件，则此信息不可用。
  - usedSlots ，已使用的席位数量。若产品为附加组件，仅当附加组件类型为"邮件安全"时此信息可用。
  - licenseKey ，试用版或授权订阅的许可证密钥。
  - isAddon ，标识产品是否为附加组件或基础许可证
country - 表示国家代码的字符串，格式为 ISO 3166 。若未指定代码，则字符串值为 N/A
state - 表示国家行政区代码的字符串，格式为 ISO 3166 。若未指定代码，则字符串值为 N/A
contactPerson - 一个包含联系人详细信息的对象：
- fullName ，其名字和姓氏
- email ，其业务电子邮件地址
- phoneNumber ，其业务电话号码
- companyRole ，其在公司的职位
mdrContactInformation - 一个包含MDR联系人详细信息的对象：
- fullName ，其名字和姓氏
- email ，其业务电子邮件地址
- phoneNumber ，其业务电话号码
customFields - 一个包含公司自定义字段值的对象：
- 自定义字段名称1 ，自定义字段值1
- 自定义字段名称2 ，自定义字段值2

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 ，若此终端具有中继角色
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": 3,
           "filters": {
               "type": {
                   "companies": true,
                   "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` .

可用筛选器

章节	小节	筛选选项
`type`		`公司` - 布尔值，用于筛选所有公司。默认值： `False` . `companyFolders` - 一个布尔值，用于筛选包含公司的所有文件夹。默认值： `False` . `groups` - 一个布尔值，用于筛选所有自定义端点组。默认值： `False` . `ec2Instances` - 一个布尔值，用于筛选所有Amazon EC2实例。默认值： `False` . `computers` - 一个布尔值，用于筛选所有计算机。默认值： `False` . `virtualMachines` - 一个布尔值，用于筛选所有虚拟机。默认值： `False` .
`security`	management	`managedWithBest` - 一个布尔值，用于筛选所有安装了安全代理的端点。默认值： `False` . `isContainerHost` - 一个布尔值，用于筛选所有安装了容器主机保护的端点。默认值： `False` . 此筛选器适用于 `计算机` 和 `虚拟机` 服务。 `受管理的Exchange服务器` - 布尔值，用于筛选所有受保护的Exchange服务器。默认值： `False` . 此筛选器需要覆盖安全服务的有效许可证密钥。 `受管理的中继` - 布尔值，用于筛选所有具有中继角色的端点。默认值： `False` . `安全服务器` - 布尔值，用于筛选所有安全服务器。默认值： `False` .
`深度`		`递归所有项目` - 布尔值，用于在公司网络清单中递归筛选所有端点。默认值： `False` .
`详细信息`		`SSID` - 字符串，用于筛选端点的SSID（端点的Active Directory SID），无论其保护状态如何。 `MAC地址` - 数组，用于筛选端点的MAC地址列表，无论其保护状态如何。 `订阅类型` - 整数数组，表示用于筛选公司的许可证订阅类型列表： `1` - 试用许可证的公司， `2` - 年度许可证的公司及拥有按月计费许可证密钥的合作伙伴公司， `3` - 按月订阅的公司， `4` - 按月试用许可证的公司， `5` - 按月订阅试用的公司 `companyType` - 用于按公司与Bitdefender关系筛选的整型参数： `0` - 合作伙伴公司， `1` - 客户公司 `name` - 用于按名称筛选项的字符串。最小字符串长度为3个字符。

重要提示

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

字段 name 支持部分匹配。

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

例如：

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

如果 名称 为 *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 - 容器。
- 详细信息 ，关于该项目的更多信息。此字段适用于 1 - 公司， 5 - 计算机， 6 - 虚拟机， 7 - EC2实例以及 16 - 容器。有关details成员内容的详细信息，请参阅 details成员 .

details成员

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

项类型	详情
`1（公司）`	`type` - 公司类型：0表示合作伙伴，1表示客户 `address` - 公司的实际地址 `phone` - 公司的电话号码 `canBeManagedByAbove` - 布尔值，表示合作伙伴是否可以管理该公司的安全性 `isSuspended` - 布尔值，表示公司账户是否被暂停 `createdAt` - 字符串，表示公司创建时的UTC日期和时间 `licenseInfo` - 包含公司许可证订阅信息的对象： `subscriptionType` - 公司的订阅类型： `1` 表示试用订阅， `2` 用于授权订阅， `3` 用于月度订阅， `4` 用于月度授权试用， `5` 用于月度订阅试用， `6` 用于FRAT订阅 `isAddon` - 标识产品是否为附加组件 `expiryDate` - 许可证到期日期 `usedSlots` - 已使用的席位数量 `totalSlots` - 授权订阅的总席位数量，或从母公司继承月度授权的子公司的预留席位数量。 `licenseKey` - 试用或授权订阅的许可证密钥。 `endSubscription` - 订阅结束日期。此选项适用于月度订阅的公司。 `autoRenewPeriod` - 订阅自动续订周期（以月为单位）。此选项适用于月度订阅的公司。 `manageExchange` - 若公司被允许管理Security for Exchange功能则为true，否则为false `manageEncryption` - 若公司被允许管理全盘加密功能则为true，否则为false `manageRemoteEnginesScanning` - 若公司被允许管理虚拟化环境安全功能则为true，否则为false 注意若存在以下任一参数，则不得使用此参数： `manageRemoteEnginesScanning` 与 `manageRemoteEnginesScanningResell` 设置（位于 `ownUse` 及 `resell` 对象参数下）。 `manageHyperDetect` - 若公司被允许管理HyperDetect功能，则为true，否则为false `manageSandboxAnalyzer` - 若公司被允许管理沙箱分析器功能，则为true，否则为false `managePatchManagement` - 若公司被允许管理补丁管理功能，则为true，否则为false `manageEventCorrelator` - 若公司被允许管理端点检测与响应功能，则为true，否则为false。 `manageEmailSecurity` - 若公司被允许管理邮件安全功能，则为true，否则为false。 `manageMobileSecurity` - 若公司被允许管理移动安全功能，则为true，否则为false。 `manageContainerProtection` - 若公司被允许管理容器保护功能，则为true，否则为false。注意若存在以下任一参数，则不得使用此参数： `manageContainerProtection` 与 `manageContainerProtectionResell` 设置（位于 `ownUse` 和 `转售` 对象参数存在。 `管理完整性监控` - 若公司被允许管理完整性监控功能则为true，否则为false。 `完整性监控数据保留` - 表示事件存储天数的整数值。仅当 `manageIntegrityMonitoring` 为 `true` 时返回。可选值： `0` （7天保留期）, `1` （90天保留期）, `2` （180天保留期）, `3` （1年保留期）。 `自用` ，包含公司服务及附加功能激活设置的对象。 `管理XDR身份提供商` ，布尔值，指定公司是否被允许在传感器管理中激活Azure AD和Active Directory集成。 `管理XDR生产力应用` ，布尔值，指定公司是否被允许在传感器管理中激活Office 365集成。 `管理XDR网络` ，布尔值，指定公司是否被允许在传感器管理中激活网络传感器集成。 `管理XDR云工作负载` ，布尔值，指定公司是否被允许在传感器管理中激活AWS集成。注意如果 `manageXDRIdentityProviders` , `manageXDRProductivityApps` , `manageXDRNetwork` 或 `manageXDRCloudWorkloads` 任一参数设置为true， `XDR` 将为企业激活。 `manageRemoteEnginesScanning` 为可选参数，表示是否为企业激活虚拟化环境安全功能。可选值： `true` 或 `false` 。默认值： `false` . `manageEventCorrelator` 为可选参数，表示是否为企业激活端点检测与响应（EDR）功能。可选值： `true` 或 `false` 。默认值： `false` . `manageSandboxAnalyzer` 为可选参数，表示是否为企业激活沙箱分析功能。可选值： `true` 或 `false` 。默认值： `false` . `manageHyperDetect` ，可选参数，表示是否为您的公司启用了HyperDetect。可能取值： `true` 或 `false` 。默认值： `false` . `managePHASR` ，可选参数，表示是否为您的公司启用了PHASR。可能取值： `true` 或 `false` 。默认值： `false` . 该参数仅在 `subscriptionType` 取以下值时返回： `3` （月度订阅） `5` （月度试用订阅） `resell` ，包含公司服务和附加组件转售设置的对象。 `manageXDRResell` 一个布尔值，指定公司是否被允许向客户销售扩展检测与响应服务。 `manageRemoteEnginesScanningResell` 可选，表示公司能否向客户销售虚拟化环境安全解决方案。可能取值： `true` 或 `false` 。默认值： `false` . `manageEventCorrelatorResell` 可选，表示公司能否向客户销售端点检测与响应（EDR）。可能取值： `true` 或 `false` 。默认值： `false` . `manageSandboxAnalyzerResell` 可选，表示公司能否向客户销售沙箱分析器。可能取值： `true` 或 `false` 。默认值： `false` . `manageHyperDetectResell` 可选，表示公司能否向客户销售HyperDetect。可能取值： `true` 或 `false` 。默认值： `false` . `managePHASRResell` ，可选，表示公司是否可以向其客户销售PHASR。可能的值： `true` 或 `false` 。默认值： `false` . 该参数仅在 `subscriptionType` 取以下值时返回： `3` ，表示月度订阅 `5` ，表示月度订阅试用 `licensedServices` ，包含公司服务设置的对象。 `mdrServiceFlavor` ，整数，表示公司自用的MDR服务版本。可能的值： `1` 表示基础版。若公司无自用MDR服务则无此参数。 `mdrServiceStatus` ，整数，表示MDR服务状态。可能的值： `1` 表示活跃， `2` 表示未激活状态 `3` 表示 onboarding 状态 `4` 表示切换中状态 `5` 表示禁用状态。若公司未启用自用MDR服务，则此参数不显示。 `mdrStatusStartDate` 服务起始日期。若公司未启用自用MDR服务，则此参数不显示。 `mdrServiceResell` 布尔值，标识该公司是否被允许向旗下创建的公司转售MDR服务。 `minimumUsage` 包含许可证类型及公司通过法律协议承诺每月最低使用量的对象： `endpointMonthlyUsage` 客户同意从主许可证中使用的最低终端数量。 `assignedProductType` 分配给公司的产品类型： `0` 表示终端安全产品 `3` 表示 Bitdefender EDR 产品仅当subscriptionType为以下值时返回该参数： `3` 表示月度订阅 `5` 表示月度试用订阅 `additionalProductTypes` 可分配给子公司的产品类型数组： `0` 表示终端安全产品 `3` ，适用于Bitdefender EDR 该参数仅在 `subscriptionType` 取以下值时返回： `3` ，表示月度订阅 `5` ，表示月度订阅试用 `assignedProtectionModel` - 表示公司将采用防护模型类型的字符串 `aLaCarte` `mspSecure` `mspSecurePlus` `mspSecureExtra` 该参数仅在满足以下全部条件时返回： `type` = `3` （月度安全版） `assignedProductType` = `0` （终端安全） `additionalProtectionModels` - 表示防护模型类型的字符串数组。该参数允许合作伙伴公司为客户分配除 `assignedProtectionModel` 对象提供之外的额外防护模型 `aLaCarte` `mspSecure` `mspSecurePlus` `mspSecureExtra` 当满足以下任一条件时返回此参数： `assignedProductType` = `3` (Bitdefender EDR), `additionalProductType` 必须包含 `0` (终端安全), 且 `type` = `3` (月度安全订阅)。 `assignedProductType` = `0` (终端安全), `type` = `3` (月度订阅)。 `reservedSlots` - 为子公司保留的总席位数。此选项仅适用于采用月度许可的合作伙伴公司。 additionalLicenses - 仅当公司分配了多个产品（附加组件或基础许可）时出现。包含关于附加组件和分配给该公司的主许可信息的数组： `expiryDate` ，许可到期日期。若产品为附加组件，则不提供此信息。 `usedSlots` ，已使用的席位数。若产品为附加组件，仅当附加组件类型为"邮件安全"时提供此信息。 `licenseKey` ，试用版或授权订阅的许可证密钥。 `isAddon` ，标识该产品是附加组件还是基础许可证。 `country` ——表示国家代码的字符串，格式为 ISO 3166 。若未指定代码，则该字符串值为 `N/A` `state` ——表示国家行政区划代码的字符串，格式为 ISO 3166 。若未指定代码，则该字符串值为 `N/A` `contactPerson` ——包含联系人详细信息的对象： `fullName` ，其名字与姓氏 `email` ，其商务邮箱地址 `phoneNumber` ，其商务电话号码 `companyRole` ，其在公司中的职位 `customFields` ——包含公司自定义字段值的对象： `自定义字段名称1` ，自定义字段值1 `自定义字段名称2` ，自定义字段值2
`5(计算机)、6(虚拟机)和7(EC2实例)`	`标签` ，为终端设置的标签 `完全限定域名` ，终端的完全限定域名 `组ID` ，终端的组ID `是否受管理` ，布尔值 `真` ，若该终端受管理 `机器类型` ，机器类型：( `1` - 计算机, `2` - 虚拟机, `3` - EC2实例, `0` - 其他) `操作系统版本` ，终端的操作系统版本 `IP地址` ，终端的IP地址 `MAC地址列表` ，终端的MAC地址列表 `SSID` ，终端的Active Directory SID `最佳管理方式` ，布尔值 `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` - 执行扫描的日期。

项类型

详情

1（公司）

type - 公司类型：0表示合作伙伴，1表示客户
address - 公司的实际地址
phone - 公司的电话号码
canBeManagedByAbove - 布尔值，表示合作伙伴是否可以管理该公司的安全性
isSuspended - 布尔值，表示公司账户是否被暂停
createdAt - 字符串，表示公司创建时的UTC日期和时间
licenseInfo - 包含公司许可证订阅信息的对象：
- subscriptionType - 公司的订阅类型： 1 表示试用订阅， 2 用于授权订阅， 3 用于月度订阅， 4 用于月度授权试用， 5 用于月度订阅试用， 6 用于FRAT订阅
- isAddon - 标识产品是否为附加组件
- expiryDate - 许可证到期日期
- usedSlots - 已使用的席位数量
- totalSlots - 授权订阅的总席位数量，或从母公司继承月度授权的子公司的预留席位数量。
- licenseKey - 试用或授权订阅的许可证密钥。
- endSubscription - 订阅结束日期。此选项适用于月度订阅的公司。
- autoRenewPeriod - 订阅自动续订周期（以月为单位）。此选项适用于月度订阅的公司。
- manageExchange - 若公司被允许管理Security for Exchange功能则为true，否则为false
- manageEncryption - 若公司被允许管理全盘加密功能则为true，否则为false
- manageRemoteEnginesScanning - 若公司被允许管理虚拟化环境安全功能则为true，否则为false
  
  注意
  
  若存在以下任一参数，则不得使用此参数： manageRemoteEnginesScanning 与 manageRemoteEnginesScanningResell 设置（位于 ownUse 及 resell 对象参数下）。
- manageHyperDetect - 若公司被允许管理HyperDetect功能，则为true，否则为false
- manageSandboxAnalyzer - 若公司被允许管理沙箱分析器功能，则为true，否则为false
- managePatchManagement - 若公司被允许管理补丁管理功能，则为true，否则为false
- manageEventCorrelator - 若公司被允许管理端点检测与响应功能，则为true，否则为false。
- manageEmailSecurity - 若公司被允许管理邮件安全功能，则为true，否则为false。
- manageMobileSecurity - 若公司被允许管理移动安全功能，则为true，否则为false。
- manageContainerProtection - 若公司被允许管理容器保护功能，则为true，否则为false。
  
  注意
  
  若存在以下任一参数，则不得使用此参数： manageContainerProtection 与 manageContainerProtectionResell 设置（位于 ownUse 和 转售 对象参数存在。
- 管理完整性监控 - 若公司被允许管理完整性监控功能则为true，否则为false。
- 完整性监控数据保留 - 表示事件存储天数的整数值。仅当 manageIntegrityMonitoring 为 true 时返回。可选值： 0 （7天保留期）, 1 （90天保留期）, 2 （180天保留期）, 3 （1年保留期）。
- 自用 ，包含公司服务及附加功能激活设置的对象。
  - 管理XDR身份提供商 ，布尔值，指定公司是否被允许在传感器管理中激活Azure AD和Active Directory集成。
  - 管理XDR生产力应用 ，布尔值，指定公司是否被允许在传感器管理中激活Office 365集成。
  - 管理XDR网络 ，布尔值，指定公司是否被允许在传感器管理中激活网络传感器集成。
  - 管理XDR云工作负载 ，布尔值，指定公司是否被允许在传感器管理中激活AWS集成。
    
    注意
    
    如果 manageXDRIdentityProviders , manageXDRProductivityApps , manageXDRNetwork 或 manageXDRCloudWorkloads 任一参数设置为true， XDR 将为企业激活。
  - manageRemoteEnginesScanning 为可选参数，表示是否为企业激活虚拟化环境安全功能。可选值： true 或 false 。默认值： false .
  - manageEventCorrelator 为可选参数，表示是否为企业激活端点检测与响应（EDR）功能。可选值： true 或 false 。默认值： false .
  - manageSandboxAnalyzer 为可选参数，表示是否为企业激活沙箱分析功能。可选值： true 或 false 。默认值： false .
  - manageHyperDetect ，可选参数，表示是否为您的公司启用了HyperDetect。可能取值： true 或 false 。默认值： false .
  - managePHASR ，可选参数，表示是否为您的公司启用了PHASR。可能取值： true 或 false 。默认值： false .
  该参数仅在 subscriptionType 取以下值时返回：
  - 3 （月度订阅）
  - 5 （月度试用订阅）
- resell ，包含公司服务和附加组件转售设置的对象。
  - manageXDRResell 一个布尔值，指定公司是否被允许向客户销售扩展检测与响应服务。
  - manageRemoteEnginesScanningResell 可选，表示公司能否向客户销售虚拟化环境安全解决方案。可能取值： true 或 false 。默认值： false .
  - manageEventCorrelatorResell 可选，表示公司能否向客户销售端点检测与响应（EDR）。可能取值： true 或 false 。默认值： false .
  - manageSandboxAnalyzerResell 可选，表示公司能否向客户销售沙箱分析器。可能取值： true 或 false 。默认值： false .
  - manageHyperDetectResell 可选，表示公司能否向客户销售HyperDetect。可能取值： true 或 false 。默认值： false .
  - managePHASRResell ，可选，表示公司是否可以向其客户销售PHASR。可能的值： true 或 false 。默认值： false .
  该参数仅在 subscriptionType 取以下值时返回：
  - 3 ，表示月度订阅
  - 5 ，表示月度订阅试用
- licensedServices ，包含公司服务设置的对象。
  - mdrServiceFlavor ，整数，表示公司自用的MDR服务版本。可能的值： 1 表示基础版。若公司无自用MDR服务则无此参数。
  - mdrServiceStatus ，整数，表示MDR服务状态。可能的值： 1 表示活跃， 2 表示未激活状态 3 表示 onboarding 状态 4 表示切换中状态 5 表示禁用状态。若公司未启用自用MDR服务，则此参数不显示。
  - mdrStatusStartDate 服务起始日期。若公司未启用自用MDR服务，则此参数不显示。
  - mdrServiceResell 布尔值，标识该公司是否被允许向旗下创建的公司转售MDR服务。
- minimumUsage 包含许可证类型及公司通过法律协议承诺每月最低使用量的对象：
  - endpointMonthlyUsage 客户同意从主许可证中使用的最低终端数量。
- assignedProductType 分配给公司的产品类型：
  - 0 表示终端安全产品
  - 3 表示 Bitdefender EDR 产品
  仅当subscriptionType为以下值时返回该参数：
  - 3 表示月度订阅
  - 5 表示月度试用订阅
- additionalProductTypes 可分配给子公司的产品类型数组：
  - 0 表示终端安全产品
  - 3 ，适用于Bitdefender EDR
  该参数仅在 subscriptionType 取以下值时返回：
  - 3 ，表示月度订阅
  - 5 ，表示月度订阅试用
- assignedProtectionModel - 表示公司将采用防护模型类型的字符串
  - aLaCarte
  - mspSecure
  - mspSecurePlus
  - mspSecureExtra
  该参数仅在满足以下全部条件时返回：
  - type = 3 （月度安全版）
  - assignedProductType = 0 （终端安全）
- additionalProtectionModels - 表示防护模型类型的字符串数组。该参数允许合作伙伴公司为客户分配除 assignedProtectionModel 对象提供之外的额外防护模型
  - aLaCarte
  - mspSecure
  - mspSecurePlus
  - mspSecureExtra
  当满足以下任一条件时返回此参数：
  - assignedProductType = 3 (Bitdefender EDR), additionalProductType 必须包含 0 (终端安全), 且 type = 3 (月度安全订阅)。
  - assignedProductType = 0 (终端安全), type = 3 (月度订阅)。
- reservedSlots - 为子公司保留的总席位数。此选项仅适用于采用月度许可的合作伙伴公司。
- additionalLicenses - 仅当公司分配了多个产品（附加组件或基础许可）时出现。包含关于附加组件和分配给该公司的主许可信息的数组：
  - expiryDate ，许可到期日期。若产品为附加组件，则不提供此信息。
  - usedSlots ，已使用的席位数。若产品为附加组件，仅当附加组件类型为"邮件安全"时提供此信息。
  - licenseKey ，试用版或授权订阅的许可证密钥。
  - isAddon ，标识该产品是附加组件还是基础许可证。
country ——表示国家代码的字符串，格式为 ISO 3166 。若未指定代码，则该字符串值为 N/A
state ——表示国家行政区划代码的字符串，格式为 ISO 3166 。若未指定代码，则该字符串值为 N/A
contactPerson ——包含联系人详细信息的对象：
- fullName ，其名字与姓氏
- email ，其商务邮箱地址
- phoneNumber ，其商务电话号码
- companyRole ，其在公司中的职位
customFields ——包含公司自定义字段值的对象：
- 自定义字段名称1 ，自定义字段值1
- 自定义字段名称2 ，自定义字段值2

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

标签 ，为终端设置的标签
完全限定域名 ，终端的完全限定域名
组ID ，终端的组ID
是否受管理 ，布尔值 真 ，若该终端受管理
机器类型 ，机器类型：( 1 - 计算机, 2 - 虚拟机, 3 - EC2实例, 0 - 其他)
操作系统版本 ，终端的操作系统版本
IP地址 ，终端的IP地址
MAC地址列表 ，终端的MAC地址列表
SSID ，终端的Active Directory SID
最佳管理方式 ，布尔值 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 - 执行扫描的日期。

示例

请求 :

{
       "params": {
           "parentId": "23b19c39b1a43d89367b32ce",
           "page": 1,
           "perPage": 3,
           "filters": {
               "type": {
                   "companies": true,
                   "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
}

在本节中 :

获取网络库存项

重要提示

参数

可用选项

可用筛选器

重要提示

返回值

details 成员

注意

注意

注意

示例

版本1.0

参数

可用选项

可用筛选器

重要提示

返回值

details成员

注意

注意

注意

示例

搜索结果