获取拦截清单条目
本方法列出拦截清单中存在的所有哈希值。
参数
|
参数 |
说明 |
请求包含项 |
类型 |
取值 |
|---|---|---|---|---|
|
|
黑名单条目所属企业的ID。 |
可选 |
字符串 |
必须是用户有权管理的有效企业ID。 默认值：发起请求所用API密钥所属的企业。 |
|
|
当前显示的结果页码。 |
必填 |
整数 |
默认值：
|
|
|
单页显示的条目数量。 |
必填 |
整数 |
可选值：
默认值：
|
返回值
此方法返回一个包含现有阻止列表规则信息的对象。返回的对象包含以下属性：
|
属性 |
类型 |
描述 |
|---|---|---|
|
|
整数 |
请求返回的规则总数。 |
|
|
整数 |
当前显示的页码。 |
|
|
整数 |
每页显示的结果数量。 |
|
|
整数 |
请求返回的总页数。 |
|
|
对象 |
与目标公司关联的现有规则列表。 |
|
|
字符串 |
项目的唯一标识符。 |
|
|
字符串 |
列表中包含的实体类型。 可选值：
|
|
|
对象 |
提供项目如何被添加到列表中的信息。 |
|
|
字符串 |
指示条目来源的类型。 可能的值：
|
|
|
字符串 |
项目添加到列表时赋予的描述。 |
|
|
对象 |
提供列表所属公司的信息。 |
|
|
字符串 |
公司的ID。 |
|
|
字符串 |
列表所属公司的名称。 |
|
|
对象 |
提供关于 GravityZone 创建规则的用户的信息。 |
|
|
字符串 |
该 GravityZone 用户的ID。 |
|
|
字符串 |
用户的电子邮件地址。 |
|
|
时间戳 |
该项目被添加到阻止列表的日期和时间。 |
|
|
对象 |
包含有关规则的信息。有关对象中包含的设置信息，请参考 addToBlocklist . |
示例
请求
{
"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": "测试"
},
"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": "入站",
"ruleName": "规则 1#",
"ruleId": "b09081b1-3651-4709-89af-731ba3c0d92c",
"operatingSystems": [
"Windows"
]
}
}
]
}
}
针对
类型
=
路径
:
{
"参数": {
"公司ID": "65fd7506e2354158650c7c32",
"类型": '路径',
"规则": [
{
'备注': '测试',
'详情': {
'路径': "C:\\aaa.exe"
}
},
{
'备注': '测试',
'详情': {
'路径': "C:\\test.exe"
}
},
],
"递归": true
},
"jsonrpc": "2.0",
"方法": "添加到阻止列表",
"ID": "5087eab8-b74f-4a3e-85b3-4271e85890d5"
}
参数
|
参数 |
类型 |
可选 |
描述 |
|---|---|---|---|
|
|
字符串 |
是 |
设置后，该方法仅列出具有所提供ID的公司阻止列表中的项目。 |
|
|
数字 |
是 |
结果页码。默认值为1。 |
|
|
数字 |
是 |
每页显示的项目数。上限为每页100个项目。默认值：每页30个项目。 |
返回值
项目
- 阻止列表项目的列表。列表中的每个条目包含以下字段：
-
ID，阻止列表中哈希项的ID。 -
哈希类型，用于获取哈希值的算法。可能取值：1- SHA256，2- MD5 -
hash，特定文件的哈希值。 -
source，哈希条目的来源。可能取值：1- 事件，2- 导入，3- 手动。 -
sourceInfo，项目的描述信息，由用户添加到阻止列表时提供。 -
filename，哈希值对应的文件名。仅当存在该信息时显示此字段。 -
companyId，阻止列表中与此项目关联的公司ID。
示例
请求 :
{
"params": {"companyId" : "5b680f6fb1a43d860a7b23c8"},
"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
}
}