跳至主内容

添加到阻止列表

使用此方法可设置一个或多个规则，用于将项目添加到阻止列表。

重要提示

此方法已更新至1.2版本。如需查看1.0版本的适用信息，请参阅 本节内容 .

1.0版本仅兼容哈希类型的阻止列表规则。

参数

参数

描述

包含在请求中

类型

取值

companyId

该Blocklist条目所属公司的ID。

可选

字符串

必须是用户有权管理且许可证包含Blocklist功能访问权限的有效公司ID。

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

type

指定要创建的规则类型。

必填

字符串

可选值：

  • hash

  • path

  • connection

rules

包含要创建的规则列表及其分配设置。

必填

对象数组

只能添加与 type 参数指定类型匹配的规则。

参见 rules .

递归

表示规则是否递归应用于目标公司管理的所有子公司。

默认值： true

可选

布尔型

无额外要求。

对象

规则

参数

描述

包含于请求中

类型

取值

备注

为当前规则集提供描述说明。

可选

字符串

无额外要求。

详情

标识具体规则及其设置项。

必填

对象

参见 详情 .

详情

当类型为哈希时可用的参数 类型 = 哈希 :

参数

描述

是否包含在请求中

类型

取值

算法

用于生成哈希值的算法

必填

字符串

可选值：

  • sha256

  • md5

哈希值

需要拦截文件对应的哈希值

必填

字符串

哈希值格式必须符合 算法 参数指定的格式

当类型为连接时可用的参数 类型 = 连接 :

参数

描述

包含在请求中

类型

取值

ruleName

规则在规则表中列出的名称（例如，规则所适用的应用程序名称）。

必填

字符串

无额外要求。

commandLine

若包含此项，则仅当应用程序通过Windows命令行界面使用指定命令打开时，规则才适用。

可选

字符串

无额外要求。

protocol

若包含此项，则仅当连接使用特定IP协议时，规则才适用。

可选

字符串

可选值：

  • 任意

  • TCP

  • UDP

  • 等

完整协议列表可查阅 此处 .

direction

若包含此项，则规则仅适用于特定方向的连接。

可选

字符串

可选值：

  • 入站

  • 出站

  • 双向

ipVersion

若包含此字段，则规则仅适用于特定IP类型的连接。

可选

字符串

可选值：

  • 任意

  • IPv4

  • IPv6

localAddress

若包含此字段，则规则仅适用于特定本地网络地址的连接。

可选

对象

参见 localAddress .

remoteAddress

若包含此字段，则规则仅适用于特定远程地址的连接。

可选

对象

参见 remoteAddress .

directlyConnected

若启用，则规则仅适用于特定MAC地址的连接。

可选

对象

请参阅 directlyConnected .

operatingSystems

若包含此字段，则规则仅适用于使用指定操作系统的端点发起的连接。

可选

字符串数组

可选值：

  • windows

  • mac

当 type = path :

参数

描述

请求中包含

类型

取值

path

所有从指定路径启动的应用程序将被阻止。

必填

字符串

路径格式必须与目标端点的操作系统匹配。

localAddress

该对象仅在 type = connection时可用 .

参数

描述

包含于请求中

类型

取值

任意

若为 false ，则仅阻止源自 ipMask 设置项下指定地址的连接。

若为 true ，则无论IP地址如何，所有连接均被阻止。

必填

布尔值

无额外要求。

ipMask

若 any = false ，则仅阻止与此设置项下指定地址之间的连接。

可选

字符串

取值可为IP地址或IP/掩码格式。

portRange

若使用范围值，则仅阻止通过这两个端口值之间端口的连接。

若指定具体端口，则仅阻止通过该端口的连接。

可选

字符串

无额外要求。

remoteAddress

该对象仅在 type = connection .

参数

描述

包含于请求中

类型

取值

any

若为 false ，则仅阻止源自 ipMask 设置中指定地址的连接。

若为 true ，则阻止所有连接，无论IP地址如何。

必选

布尔值

无额外要求。

ipMask

若 任意 = false ，仅阻止与此设置下指定地址的连接。

可选

字符串

值可采用IP或IP/掩码格式。

端口范围

若使用范围值，则仅阻止通过这两个端口值之间端口的连接。

若指定具体端口，则仅阻止通过该端口的连接。

可选

字符串

无额外要求。

直接连接

该对象仅在 类型 = 连接 .

参数

描述

包含于请求中

类型

取值

任意

指示是否启用此选项。

必填

布尔值

无额外要求。

remoteMac

仅允许来自指定Mac地址的连接。

必填

字符串

必须为有效的Mac地址格式。

返回值

属性

类型

描述

result

布尔值

指示操作是否成功。

错误信息

代码

消息

详情

-32602

参数无效 

"details": "验证异常：哈希值1e0905327f443c54aa617e2ff323067c985428e5566886f2aa8296cddfe6ddf9d不是SHA256算法的有效字符串表示"
 
"details": "遇到多个错误",
      "errors": [
        {
          "companyId": "65fd7506e2354158650c7c32",
          "companyName": "P1",
          "message": "超出限制"
        },
        {
          "companyId": "65fd7506e2354158650c7c33",
          "companyName": "C1",
          "message": "超出限制"
        }

示例

请求

当请求 type = hash : 

{
  "params": {
    "companyId": "65fd7506e2354158650c7c32",
    "type": "hash",
    "rules": [
      {
        "note": "测试",
        "details": {
          "algorithm": "sha256",
          "hash": "1e0905327f443c54aa617e2ff323067c985428e5566886f2aa8296cddfe6ddf9"
        }
      },
      {
        "details": {
          "algorithm": "md5",
          "hash": "13f6331c638b68d4e7eab6ea60da5473"
        }
      }
    ],
    "recursive": false
  },
  "jsonrpc": "2.0",
  "method": "addToBlocklist",
  "id": "5087eab8-b74f-4a3e-85b3-4271e85890d5"
}

当请求类型 type = connection : 

{
  "params": {
    "companyId": "686e0b158fee1c4cc30f59b2",
    "type": "connection",
    "rules": [
      {
        "note": "测试",
        "details": {
          "ruleName": "规则1#",
          "path": "C:\\test.exe",
          "commandLine": "格式化 C:\\",
          "hash": "13f6331c638b68d4e7eab6ea60da5473",
          "protocol": "ICMP",
          "direction": "入站",
          "ipVersion": "IPV4",
          "localAddress": {
            "any": false,
            "ipMask": "10.10.10.12/32",
            "portRange": "300-400"
          },
          "remoteAddress": {
            "any": false,
            "ipMask": "10.10.10.12/32",
            "portRange": "300-400"
          },
          "directlyConnected": {
            "enable": true,
            "remoteMac": "AA:AA:AA:AA:AA:AA;CC:CC:CC:CC:CC:CC;BB:BB:BB:BB:BB:BB"
          },
            "operatingSystem": [
                "Windows"
            ]
        }
      }
    ],
    "recursive": true
  },
  "jsonrpc": "2.0",
  "method": "addToBlocklist",
  "id": "5087eab8-b74f-4a3e-85b3-4271e85890d5"
}

当请求类型 type = path : 

{
  "params":  {
    "companyId":  "65fd7506e2354158650c7c32",
    "type":  'path',
    "rules":  [
      {
        'note':  '测试',
        'details':  {
          'path': "C:\\aaa.exe"
        }
      },
      {
        'note':  '测试',
        'details':  {
          'path':  "C:\\test.exe"
        }
      },
    ],
    "recursive":  true
  },
  "jsonrpc":  "2.0",
  "method":  "addToBlocklist",
  "id":  "5087eab8-b74f-4a3e-85b3-4271e85890d5"
}

响应 

{
  "id": "5087eab8-b74f-4a3e-85b3-4271e85890d5",
  "jsonrpc": "2.0",
  "result": true
}

版本1.0

使用此方法将一个或多个文件哈希添加到阻止列表。

参数

参数

类型

可选

描述

hashType

数值

否

用于获取哈希的算法。可能的值： 1 - SHA256， 2 - MD5

hashList

数组

否

包含多个哈希值的数组。所有哈希值必须是由 hashType 参数指定的类型。

companyId

字符串

是

该拦截列表条目所属公司的ID。

sourceInfo

字符串

否

哈希值的描述信息。

返回值

此方法返回一个布尔值，若操作成功则为True。

示例

请求 : 

{
   "id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
   "jsonrpc": "2.0",
   "method": "addToBlocklist",
   "params": {"companyId": "5b680f6fb1a43d860a7b23c8","hashType" : 2,
       "hashList": ["5b7ac19bb1a43dfb107b23c6",
                    "f696282aa4cd4f614aa995190cf442fe"],
       "sourceInfo": "通过公开API添加"
        }
  }

响应 : 

{
       "id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
       "jsonrpc": "2.0",
       "result": true
   }
本节内容 :