跳至主内容

获取PHASR建议

使用此方法获取针对公司的PHASR建议。

参数

名称

描述

包含在请求中

类型

取值

对象ID

要获取的特定建议的ID。

可选

字符串

必须是有效的建议ID。

规则ID

需要获取建议的规则ID列表。

可选

字符串数组

ID必须采用 {ruleId}-{type} 格式。

categoryIds

包含此参数时,响应将仅返回指定类型的推荐。

可选

整数数组

可选值:

  • 1 - 篡改工具

  • 2 - 黑客工具

  • 3 - 远程工具

  • 4 - 挖矿程序

  • 5 - 合法二进制文件

actionTaken

包含此参数时,响应将仅返回已执行特定操作的推荐。

可选

整数数组

可选值:

  • 0 - 需执行操作。用户需审查推荐内容并采取相应措施。

  • 1 - 已应用。当建议已应用于生成该建议的所有行为配置文件后,将设置此状态。

  • 2 - 部分应用。当建议仅应用于用户选定的特定行为配置文件集合后,将设置此状态。

类型

您希望检索的特定建议类型。

可选

整数数组

可选值:

  • 0 - 允许访问。检索允许访问类建议。

  • 1 - 限制访问。检索限制访问类建议。

  • 2 - 允许访问请求。检索允许访问请求类建议。

createdOnMin

仅包含在此特定日期时间之后创建的建议。

可选

字符串

该值必须符合ISO 8601日期格式。

createdOnMax

仅包含在此特定日期时间之前创建的建议。

可选

字符串

该值必须采用ISO 8601日期格式。

behavioralProfileIdentities

仅包含与指定标识符关联的身份相关的推荐。

可选

字符串数组

值必须为有效的行为特征身份格式。

behavioralProfileResources

仅包含与指定标识符关联的资源相关的推荐。

可选

字符串数组

值必须为有效的行为特征资源格式。

sort

决定响应中推荐项的排序依据。

可选

字符串

可选值:

  • attackSurfaceReduction

  • createdOn

dir

决定排序方向:升序或降序。

可选

字符串

可选值:

  • 升序

  • 降序

这些是通用参数,适用于所有公共API方法。

参数

描述

是否包含在请求中

类型

取值范围

id

该参数为请求添加唯一标识符,用于关联对应的响应。

目标响应中将返回相同的标识符值,便于追踪调用。

必填

字符串

无额外要求

method

请求所调用的方法名称。

必填

字符串

必须是有效的方法名。

jsonrpc

请求与响应所使用的JSON-RPC协议版本。

必填

整数

可选值:

  • 2.0

params

包含请求配置的对象。

必填

对象

无额外要求。

params 对象中

page

结果页码。

可选

整数

默认值: 1

perPage

每页显示的结果数量。

可选

整数

每页上限为100项。

默认值: 30

返回值

属性

类型

描述

条目

对象

包含特定建议的相关信息。

对象

条目

属性

类型

描述

对象ID

字符串

建议的ID。

规则ID

整数

生成该建议的规则ID。

采取的措施

整数

根据建议所采取的行动。

可能的值:

  • 0 - 允许

  • 1 - 限制

  • 2 - 部分应用

行为配置文件

整数

规则适用的行为配置文件。

攻击面缩减

整数

应用该建议后受影响的攻击面缩减程度。

类型

整数

建议的类型。

创建时间

字符串

建议创建的日期和时间。

示例

请求 :

{
  "params": {
    "page": 1,
    "perPage": 20,
    "companyId": "1234567890abcdef",
    "sort": "attackSurfaceReduction",
    "dir": "ASC",
    "objectId": "68480f4e11e8dc005bb0f9e7",
    "ruleIds": ["696-0", "596-1"],
    "categoryIds": [4, 3, 2],
    "actionTaken": [0, 1],
    "type": [0, 1, 2],
    "createdOnMin": "2025-05-07T13:21:00.704Z",
    "createdOnMax": "2025-06-06T13:21:00.704Z",
    "behavioralProfileIdentities": [
      "Local_S-1-5-21-4003642952-1244496884-1545565483-1003_67ff9a5be8e045f5713ee6f6",
      "Local_S-2-5-21-4003642952-1244496884-1545565483-1003_67ff9a5be8e045f5713ee6f7",
      "Local_S-3-5-21-4003642952-1244496884-1545565483-1003_67ff9a5be8e045f5713ee6f8"
    ],
    "behavioralProfileResources": [
      "376f7eff-b0d7-49b2-825b-2af1c0f1aede-b545e199a29e",
      "376f7eff-b0d7-49b2-825b-2af1c0f1aede-b545e199a29a",
      "376f7eff-b0d7-49b2-825b-2af1c0f1aede-b545e199a29b"
    ]
  },
  "jsonrpc": "2.0",
  "method": "getPhasrRecommendations",
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

响应 :

{
  "page": 1,
  "pagesCount": 1,
  "perPage": 4,
  "total": 4,
  "items": [
    {
      "objectId": "6864e34452037a9169c459f3",
      "ruleId": 619,
      "actionTaken": 1,
      "behavioralProfiles": 2,
      "attackSurfaceReduction": 0.05,
      "type": 1,
      "createdOn": "2025-07-02T07:44:04.000Z"
    },
    {
      "objectId": "6864e34452037a9169c459f4",
      "ruleId": 18,
      "actionTaken": 1,
      "behavioralProfiles": 2,
      "attackSurfaceReduction": 0.05,
      "type": 1,
      "createdOn": "2025-07-02T07:44:04.000Z"
    },
    {
      "objectId": "68652b4b83b317095936ffb6",
      "ruleId": 697,
      "actionTaken": 1,
      "behavioralProfiles": 1,
      "attackSurfaceReduction": 0.01,
      "type": 0,
      "createdOn": "2025-07-02T12:51:23.000Z"
    },
    {
      "objectId": "68652b4b83b317095936ffb9",
      "ruleId": 2,
      "actionTaken": 1,
      "behavioralProfiles": 1,
      "attackSurfaceReduction": 0.01,
      "type": 0,
      "createdOn": "2025-07-02T12:51:23.000Z"
    }
  ]
}