跳至主内容

获取拦截列表项

本方法列出拦截列表中存在的所有哈希值。

重要提示

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

1.0版本仅返回哈希类型拦截规则。

参数

参数

描述

是否包含在请求中

类型

取值

page

当前显示的结果页码。

必填

整数

默认值: 1

perPage

每页显示的条目数量。

必填

整数

可选值: 1 - 100 .

默认值: 30

返回值

该方法返回一个包含现有拦截规则信息的对象。返回的对象包含:

属性

类型

描述

total

整数

该请求返回的规则总数。

page

整数

当前显示的页码。

perPage

整数

每页显示的结果数量。

pagesCount

整数

该请求返回的总页数。

items

对象

与目标公司关联的现有规则列表。

id

字符串

条目的ID。

type

字符串

列表中包含的实体类型。

可能的值:

  • 哈希值

  • 应用程序路径

  • 连接规则

source

对象

提供关于条目如何被添加到列表中的信息。

类型

字符串

指示条目来源的类型。

可能的值:

  • 事件

  • 导入

  • 手动 .

描述

字符串

将此项添加到列表时给出的描述。

公司

对象

提供列表所属公司的信息。

ID

字符串

公司的ID。

名称

字符串

列表所属公司的名称。

所有者

对象

提供关于 GravityZone 创建规则的用户的信息。

ID

字符串

GravityZone 用户的ID。

用户名

字符串

用户的电子邮件地址。

创建时间

时间戳

该项目被添加到阻止列表的日期和时间。

详情

对象

包含有关规则的信息。有关对象中包含的设置信息,请参阅 添加到阻止列表 .

示例

请求

{
  "params": {
	"companyId": "65fd7506e2354158650c7c32",
	"page": 1,
	"perPage": 100
  },
  "jsonrpc": "2.0",
  "method": "getBlocklistItems",
  "id": "5087eab8-b74f-4a3e-85b3-4271e85890d5"
}

响应

针对 类型 = 哈希 :

{
  "params": {
	"companyId": "65fd7506e2354158650c7c32",
	"page": 1,
	"perPage": 100
  },
  "jsonrpc": "2.0",
  "method": "getBlocklistItems",
  "id": "5087eab8-b74f-4a3e-85b3-4271e85890d5"
}

针对 类型 = 连接 :

{
    "id": "6435c228-73b0-4e72-9a2a-8716cc58c883",
    "jsonrpc": "2.0",
    "result": {
        "total": 4,
        "page": 1,
        "perPage": 100,
        "pagesCount": 1,
        "items": [
            {
                "type": "connection",
                "source": {
                    "type": "manual",
                    "description": "test"
                },
                "company": {
                    "id": "686e0b158fee1c4cc30f59b2",
                    "name": "5YZ5J7VF4VJ8"
                },
                "owner": {
                    "id": "686d418af2379428380497ee",
                    "userName": "vagrant@bitdefender.com"
                },
                "created": "2025-07-15T12:44:22",
                "id": "687622f6132979b87b0e47a2",
                "details": {
                    "remoteAddress": {
                        "any": false,
                        "ipMask": "10.10.10.12/32",
                        "portRange": "300-400"
                    },
                    "localAddress": {
                        "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"
                    },
                    "protocol": "ICMP",
                    "path": "C:\\test.exe",
                    "hash": "13f6331c638b68d4e7eab6ea60da5473",
                    "commandLine": "format  C:\\",
                    "ipVersion": "IPV4",
                    "direction": "inbound",
                    "ruleName": "rule  1#",
                    "ruleId": "b09081b1-3651-4709-89af-731ba3c0d92c",
                    "operatingSystems": [
                        "Windows"
                    ]
                }
            }
        ]
    }
}

针对 类型 = 路径 :

{
  "params":  {
    "companyId":  "65fd7506e2354158650c7c32",
    "type":  '路径',
    "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"
}

参数

参数

类型

可选

描述

页码

数字

结果页码。默认值为1。

每页数量

数字

每页显示的条目数。上限为每页100条。默认值:每页30条。

返回值

条目 - 阻止列表条目列表。列表中的每个条目包含以下字段:

  • ID ,阻止列表中哈希条目的ID。

  • 哈希类型 ,用于生成哈希的算法。可能的值: 1 - SHA256, 2 - MD5

  • 哈希值 ,特定文件的哈希值。

  • source ,哈希条目的来源。可能的取值: 1 - 事件, 2 - 导入, 3 - 手动。

  • sourceInfo ,项目的描述信息,由用户将项目添加到阻止列表时提供。

  • filename ,哈希对应的文件名。仅当存在该信息时显示此字段。

  • companyId ,阻止列表中与此项目关联的公司ID。

示例

请求 :

{
      "params": {
          
      },
      "jsonrpc": "2.0",
      "method": "getBlocklistItems",
      "id": "0df7568c-59c1-48e0-a31b-18d83e6d9810"
  }

响应 :

{
       "id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
       "jsonrpc": "2.0",
       "result": {
           "items": [
               {
                   "companyId": "5b680f6fb1a43d860a7b23c8",
                   "hash": "098f6bcd4621d373cade4e832627b4f6",
                   "hashType": 2,
                   "id": "5b7ac19bb1a43dfb107b23c6",
                   "source": 3,
                   "sourceInfo": "通过公共API添加"
               },
               {
                   "companyId": "5b680f6fb1a43d860a7b23c8",
                   "filename": "file.txt",
                   "hash": "f696282aa4cd4f614aa995190cf442fe",
                   "hashType": 2,
                   "id": "5b7ac19bb1a43dfb107b23c7",
                   "source": 1,
                   "sourceInfo": "从事件1添加"
               }
           ],
           "page": 1,
           "pagesCount": 1,
           "perPage": 30,
           "total": 2
       }
  }