跳至主内容

获取软件包详情

此方法通过提供的ID获取特定软件包的配置信息。

警告

该 atc 模块已弃用，将在未来从API中移除。

参数

参数

类型

可选

描述

packageId

字符串

否

需要获取详情的软件包ID。

返回值

此方法返回包含软件包信息的对象。响应对象包含：

  • packageName - 软件包的名称。

  • description - 软件包的描述。

  • language - 软件包的语言，格式为LL_CC，其中LL和CC是语言和国家/地区的国际代码。

  • modules - 表示软件包中模块的状态。该对象可能包含以下成员： antimalware , advancedThreatControl 和 atc , firewall , contentControl , userControl , antiphishing , trafficScan , deviceControl , powerUser , containerProtection , 应用程序控制, 高级漏洞防护 , 加密 , 补丁管理 , 终端检测与响应传感器 , 网络攻击防御 。每个模块的值为 1 （启用）或 0 （禁用）。

    提示

    ： 内容控制 设置已弃用。若 启用 用户控制 , 反钓鱼 及 流量扫描 均设置为 启用 ，则显示为 禁用 .

  • scanMode - 描述扫描模式设置的对象，包含以下字段：

    • type ，可选值为 1 （自动）或 2 （自定义模式）

    • computers ，包含以下可选字段的对象： main （主扫描引擎）和 fallback （备用扫描引擎）。这些字段的取值可以是 1 - 带安全服务器的中央扫描， 2 - 混合扫描（轻量引擎）或 3 - 本地扫描（完整引擎）

    • vms ，包含以下可选字段的对象： main （主扫描引擎）和 fallback （备用扫描引擎）。这些字段的取值可以是 1 - 带安全服务器的中央扫描， 2 - 混合扫描（轻量引擎）或 3 - 本地扫描（完整引擎）

  • 设置 - 包含以下字段的软件包其他设置对象：

    • 安装前扫描

    • 移除竞品

    • 自定义安装路径

    • 自定义组ID

    • 虚拟机自定义组ID

  • 角色 - 包含启用/禁用角色的对象：

    • 中继 可选值为： 1 表示启用， 0 表示禁用。

    • 交换 可选值为： 1 表示启用， 0 表示禁用。

  • 部署选项 - 包含安装选项的对象：

    • 类型 ，整数，表示终端将连接到的实体。该实体将提供安装包和更新。可选值为： 1 表示从Bitdefender更新服务器常规部署； 2 表示通过中继服务器进行部署。

    • relayId ，表示已启用中继角色的终端ID字符串。当 type 选项设置为 2 （即通过中继部署）时返回此字段。

    • useCustomCommunicationServer ，布尔值，用于指定终端是否与特定通信服务器设备通信。

    • communicationServer ，包含自定义通信服务器设备IP或主机名的字符串。仅当 useCustomCommunicationServer 设置为 True .

    • useCommunicationProxy ，布尔值，用于指定终端是否使用代理进行互联网通信。可选值为： True 表示使用通信代理， False 表示不使用。

    • proxyServer ，表示代理服务器IP或域名的字符串。有效值为IPv4/IPv6格式的IP地址及符合RFC 1035标准的域名。当 useCommunicationProxy 设置为 True .

    • proxyPort ，表示代理服务器访问端口的整数，有效值介于 1 和 65535 之间。此选项在 useCommunicationProxy 设置为 True .

    • proxyUsername ，表示代理服务器认证所需的用户名字符串。若代理服务器无需认证，可省略此选项。

  • productType ——指定的产品类型。该字段决定安全代理的运行模式。可选值：

    • 0 ，表示检测与防护

    • 3 ，表示EDR（仅报告）

    • 5 ，表示PHASR独立版

示例

请求 : 

{
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "jsonrpc": "2.0",
    "method": "getPackageDetails",
    "params": {
         "packageId": "5a37b660b1a43d99117b23c6"
    }
  }

响应 : 

{
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "jsonrpc": "2.0",
    "result": {
       "packageName": "Package",
       "description": "package description",
       "language": "en_US",
       "modules": {
           "antimalware": 1,
           "advancedThreatControl": 1,
           "atc": 1,
           "firewall": 0,
           "userControl" 1,
           "antiphishing": 0,
           "trafficScan": 1,
           "deviceControl": 0,
           "powerUser": 0,
           "containerProtection": 0,"applicationControl": 0,"advancedAntiExploit": 0,
           "encryption": 0,
           "patchManagement": 0,
           "edrSensor": 0,
           
       },
       "roles": {
              "relay": 1,
              "exchange": 0
       },
       "scanMode": {
          "type": 2,
          "computers": {
              "main": 1,
              "fallback": 2
          },
          "vms": {
              "main": 2
          }
       },
       "settings": {"scanBeforeInstall": false,"removeCompetitors": true,
          "customInstallationPath": "c:\\mypath\\bitdefender",
          "customGroupId": "5a4dff50b1a43ded0a7b23c8","vmsCustomGroupId": "5a4dff50b1a43ded0a7b23c7"},
       "部署选项": {
          "类型": 1,
          "使用通信代理": true,
          "代理服务器": "10.12.13.14",
          "代理端口": 123,
          "代理用户名": "user""使用自定义通信服务器": true,
          "通信服务器": "10.12.13.14"},
       "产品类型": 0
     }
  }
本节内容 :