跳至主内容

更新软件包

调用此方法可更新安装包

警告

该 atc 模块已弃用。建议改用 advancedThreatControl 模块

参数

参数

类型

可选

描述

packageId

字符串

否

软件包的ID。

packageName

字符串

否

软件包的名称。

companyId

字符串

是

公司ID。默认值为生成API密钥的用户关联的公司ID。

description

字符串

是

软件包的描述。若未传值，则描述默认为空字符串。

language

字符串

是

软件包的语言，格式为LL_CC，其中LL表示语言，CC表示国家/地区。支持的语言包括：en_US、es_ES、de_DE、fr_FR、ro_RO、pl_PL、pt_BR、it_IT、ru_RU。若未指定，默认值为 en_US .

modules

对象

是

包含待启用/禁用模块的对象。其键名可为：

  • 高级威胁控制

  • 防火墙

  • 内容控制

    注意

    如果 内容控制 存在，其值将自动赋给 用户控制 , 反钓鱼 和 流量扫描 。若尝试为这三个键中的任意一个分配不同值，将导致错误。

    提示

    该 内容控制 设置已弃用。建议改用 用户控制 , 反钓鱼 和 流量扫描 设置。

  • 用户控制

    注意

    如果 内容控制 存在，分配给它的值也将赋给此键。

  • 反钓鱼

    注意

    如果 内容控制 存在，分配给它的值也将赋给此键。

  • 流量扫描

    注意

    如果 内容控制 存在，分配给它的值也将分配给此键。

  • 设备控制

  • 高级用户

  • EDR传感器

  • 高级反漏洞利用

  • 容器保护

  • 加密

  • 补丁管理

  • 网络攻击防御

  • 完整性监控

  • PHASR

取值可为1（启用）或0（禁用）。若未发送该模块，则视为禁用状态。

对于EDR（仅报告模式），模块参数必须采用默认配置：edrSensor、contentControl、networkAttackDefense和advancedThreatControl设为1（启用），其余模块均设为0。对于检测与防护模式，所有模块默认值均为0。

对于PHASR独立版，仅 phasr 参数在 modules 对象下被设置为 1 （启用），其他所有模块均设为 0 .

扫描模式

对象

是

包含扫描模式设置的对象。对象描述：

  • 可接受的键包括： type , vms , computers 以及 ec2 （若已配置AWS集成）。 type 的值可为1（自动模式）或2（自定义模式）。

  • 若 type 值为2，则需传递 computers , vms 与 ec2 的键值对，否则系统将填充默认值。 computers , vms 及 ec2 的值为包含以下可选键的对象： main 和 fallback .

  • 参数 main 的取值可为1（中央扫描模式（安全服务器））、2（混合扫描模式（轻量引擎））或3（本地扫描模式（完整引擎））。

  • 参数 fallback 的取值可为2（混合扫描模式（轻量引擎））或3（本地扫描模式（完整引擎））。若 main 参数选择2或3，则 fallback 参数值将被忽略。

  • 针对 ec2 的 main 参数仅支持设为1（中央扫描模式（安全服务器））。

  • 若未传递此参数，则自动模式下的默认值将被保存。

settings

对象

是

包含软件包其他设置的对象。其取值可包括：

  • removeCompetitors ,

  • uninstallPassword ,

  • customInstallationPath ,

  • customGroupId .

参数 removeCompetitors 可设置为1（启用）或0（禁用）。 uninstallPassword 应为字符串且满足复杂度要求：密码长度至少6个字符，必须包含至少一位数字、一个大写字母、一个小写字母及一个特殊字符；且 customInstallationPath 应为有效的Windows安装路径（仅适用于Windows操作系统）。 customGroupId 应为字符串，表示新终端应部署到的自定义分组实体ID。 所有参数均为可选。对于EDR（仅报告模式），settings参数必须保持默认配置：removeCompetitors设为0（禁用）。

vmsCustomGroupId 应为字符串，表示虚拟机视图中新终端应部署到的自定义分组实体ID。所有参数均为可选。

roles

对象

是

包含需启用或禁用角色的对象：

  • relay 可选值如下： 1 表示启用中继角色， 0 表示禁用。默认情况下中继角色为禁用状态。

  • exchange 可选值如下： 1 表示启用Exchange角色， 0 表示禁用。默认情况下Exchange角色为禁用状态。 仅当企业许可证包含Security for Exchange安全服务时此角色可用。

deploymentOptions

对象

是

包含安装选项的对象：

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

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

  • useCommunicationProxy ，一个布尔值，用于指定端点是否使用代理通过互联网通信。可能值为 True 表示使用通信代理， False 表示不使用。

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

  • proxyPort ，表示允许访问代理服务器端口的整数。有效值范围为 1 至 65535 当 useCommunicationProxy 设置为 True .

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

  • proxyPassword ，表示代理服务器认证所需的密码字符串。若代理服务器无需认证，可省略此选项。

productType

数值

是

此参数决定安全代理的运行模式。可选值：

  • 0 - 检测与防护模式（完整终端安全代理的默认模式）。

  • 3 - EDR（仅报告）模式（Bitdefender EDR代理的默认模式）。

  • 5 - Phasr独立模式（PHASR独立代理的默认模式）。

更多信息请参阅 参数说明 .

参数说明

  • Bitdefender EDR用户仅能创建EDR（仅报告）安装包； productType 为可选参数。

  • GravityZone BS/ABS/Elite用户仅能创建检测与防护安装包； productType 为可选参数。

  • GravityZone Ultra / Ultra Plus 用户可同时创建EDR（仅报告）和检测防护安装包； productType 必须明确指定才能创建EDR（仅报告）安装包。

  • EDR（仅报告）安装包默认包含一组预定义参数，这些参数将覆盖用户指定的选项。预定义参数包括：

    • modules

      • edrSensor-true

      • contentControl-true

      • networkAttackDefense-true

      • advancedThreatControl-true

      • 其他模块-false

    • scanMode-不适用

    • settings.removeCompetitors-false

    • settings.scanBeforeInstall-false

    • roles.exchange-false

  • PHASR独立安装包默认包含一组预定义参数，这些参数将覆盖用户指定的选项。预定义参数包括：

    • modules

      • phasr - true

    • scanMode - 不适用

    • settings.removeCompetitors - false

    • settings.scanBeforeInstall - false

    • roles.exchange - false

  • 该 完整性监控 模块不适用于产品类型EDR（仅报告）。

返回值

此方法返回一个布尔值， 真 表示包是否成功更新。

示例

请求 : 

{
     "params": {
       "packageId": "652feab6b9684f3ba80685d5"
       "packageName": "唯一名称",
       "companyId": "54a1a1d3b1a43d2b347b23c1",
       "description": "包描述",
       "language": "en_EN",
       "modules": {
           "advancedThreatControl": 1,
           "firewall": 0,
           "userControl": 1,
           "antiphishing": 1,
           "trafficScan": 1,
           "deviceControl": 0,
           "powerUser": 1,
           "edrSensor": 1,
           "advancedAntiExploit": 1,
           "containerProtection": 1,
           "encryption": 0,
           "patchManagement": 0,
           "networkAttackDefense": 1,
           "integrityMonitoring": 1
       },
       "scanMode": {
           "type": 2,
           "computers": {
               "main": 1,
               "fallback": 2
           },
           "vms": {
               "main": 2
           },
           "ec2": {
               "main": 1,
               "fallback": 2
           }
       },
       "settings": {
           "uninstallPassword": "mys3cre3tP@assword",
           "removeCompetitors": 1,
           "customInstallationPath": "c:\\mypath\\bitdefender",
           "customGroupId": "5a4dff50b1a43ded0a7b23c8"
       },
       "roles": {
           "relay": 0,
           "exchange":1
       },
       "deploymentOptions": {
           "type": 2,
           "relayId": "54a1a1s3b1a43e2b347s23c1",
           "useCommunicationProxy": true,
           "proxyServer": "10.12.13.14",
           "proxyPort": 123
       },
       "productType": 0
     },
     "jsonrpc": "2.0",
     "method": "updatePackage",
     "id": "426db9bb-e92a-4824-a21b-bba6b62d0a18"
  }

响应 : 

{
     "id": "426db9bb-e92a-4824-a21b-bba6b62d0a18",
     "jsonrpc": "2.0",
     "result": true
  }
本节内容 :