getPhasrRecommendations
调用此方法可获取指定公司的PHASR推荐内容。
参数
|
名称 |
描述 |
请求包含 |
类型 |
取值 |
|---|---|---|---|---|
|
|
需要获取PHASR推荐的目标公司ID |
可选 |
字符串 |
必须是一个您拥有管理权限的有效公司ID。 默认值：与请求所用API密钥关联的公司ID。 |
|
|
您希望获取的特定推荐条目的ID。 |
可选 |
字符串 |
必须为有效的推荐ID。 |
|
|
您希望获取推荐所对应的规则ID列表。 |
可选 |
字符串数组 |
ID必须符合
|
|
|
包含此参数时，响应将仅返回指定类型的推荐。 |
可选 |
整数数组 |
可选值：
|
|
|
包含该参数时，响应将仅返回因建议而采取特定行动的建议项。 |
可选 |
整数数组 |
可选值：
|
|
|
指定需要检索的建议类型。 |
可选 |
整数数组 |
可选值：
|
|
|
仅包含在此特定日期和时间之后创建的建议。 |
可选 |
字符串 |
值必须采用ISO 8601日期格式。 |
|
|
仅包含在此特定日期和时间之前创建的建议。 |
可选 |
字符串 |
值必须采用ISO 8601日期格式。 |
|
|
仅包含与指定标识符关联的身份的建议。 |
可选 |
字符串数组 |
值必须采用有效的行为配置文件身份格式。 |
|
|
仅包含与指定标识符关联的资源的建议。 |
可选 |
字符串数组 |
值必须采用有效的行为配置文件资源格式。 |
|
|
决定响应中推荐结果的排序依据。 |
可选 |
字符串 |
可选值：
|
|
|
决定结果的排序方向：升序或降序。 |
可选 |
字符串 |
可选值：
|
这些是公共API方法通用的参数。
|
参数 |
描述 |
是否包含在请求中 |
类型 |
取值 |
|---|---|---|---|---|
|
|
该参数为请求添加标识符，用于关联对应响应。 目标方会在响应中返回相同值，便于调用追踪。 |
必填 |
字符串 |
无额外要求 |
|
|
用于发送请求的方法名称。 |
必填 |
字符串 |
必须是有效的方法名。 |
|
|
请求与响应所使用的JSON-RPC版本。 |
必填 |
整数 |
可选值：
|
|
|
包含请求配置的对象。 |
必填 |
对象 |
无额外要求。 |
|
在
|
||||
|
|
结果页码。 |
可选 |
整数 |
默认值：
|
|
|
每页显示的结果数量。 |
可选 |
整数 |
每页上限为100条。
默认值：
|
返回值
|
属性 |
类型 |
描述 |
|---|---|---|
|
|
对象 |
包含特定推荐的相关信息。 |
对象
条目
|
属性 |
类型 |
描述 |
|---|---|---|
|
|
字符串 |
推荐的ID。 |
|
|
整数 |
生成该推荐的规则ID。 |
|
|
整数 |
根据建议采取的操作。 可能取值：
|
|
|
整数 |
规则适用的行为画像。 |
|
|
整数 |
应用建议后受影响的攻击面缩减程度。 |
|
|
整数 |
建议的类型。 |
|
|
字符串 |
建议创建的日期和时间。 |
示例
请求 :
{
"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"
}
]
}