Method: projects.sources.findings.group

过滤组织或来源的发现结果,并按其在某个位置的指定属性进行分组。如果未指定位置,则假定发现结果是在全球范围内

如需跨所有来源进行分组,请将 - 作为来源 ID 提供。以下列表显示了一些示例:

  • /v2/organizations/{organization_id}/sources/-/findings + /v2/organizations/{organization_id}/sources/-/locations/{locationId}/findings
  • /v2/folders/{folder_id}/sources/-/findings
  • /v2/folders/{folder_id}/sources/-/locations/{locationId}/findings
  • /v2/projects/{projectId}/sources/-/findings
  • /v2/projects/{projectId}/sources/-/locations/{locationId}/findings

HTTP 请求


网址使用 gRPC 转码语法。

路径参数

参数
parent

string

必需。要按其进行分组的来源的名称。如果未指定位置,则假定发现内容位于全球范围内。以下列表显示了一些示例:

  • organizations/[organization_id]/sources/[source_id] + organizations/[organization_id]/sources/[source_id]/locations/[locationId]
  • folders/[folder_id]/sources/[source_id]
  • folders/[folder_id]/sources/[source_id]/locations/[locationId]
  • projects/[projectId]/sources/[source_id]
  • projects/[projectId]/sources/[source_id]/locations/[locationId]

如需跨所有来源进行分组,请提供 - 的 source_id。以下列表显示了一些示例:

  • organizations/{organization_id}/sources/-
  • organizations/{organization_id}/sources/-/locations/[locationId]
  • folders/{folder_id}/sources/-
  • folders/{folder_id}/sources/-/locations/[locationId]
  • projects/{projectId}/sources/-
  • projects/{projectId}/sources/-/locations/[locationId]

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "filter": string,
  "groupBy": string,
  "pageToken": string,
  "pageSize": integer
}
字段
filter

string

用于定义要应用于发现结果的过滤条件的表达式。该表达式是通过逻辑运算符 ANDOR 组合的一个或多个限制条件的列表。支持括号,并且 OR 的优先级高于 AND

限制的形式为 <field> <operator> <value>,并且可能在前面带有 - 字符以表示否定。例如:

  • name
  • securityMarks.marks.marka

支持的运算符包括:

  • =(适用于所有值类型)。
  • ><>=<=,表示整数值。
  • :,表示字符串的子字符串匹配。

支持的值类型包括:

  • 字符串字面量用引号括起来。
  • 不带引号的整数字面量。
  • 不带引号的布尔值字面量 truefalse

支持以下字段和运算符组合:

  • 名称:=
  • 父级:=:
  • resourceName:=:
  • 状态:=:
  • 类别:=:
  • externalUri:=:
  • eventTime:=><>=<=

用法:此值应为从公元纪年起算的毫秒数,或 RFC3339 字符串。示例:eventTime = "2019-06-10T16:07:18-07:00" eventTime = 1560208038000

  • 严重程度:=:
  • securityMarks.marks:=:
  • resource:
  • resource.name:=:
  • resource.parent_name: =:
  • resource.parent_display_name: =, :
  • resource.project_name:=:
  • resource.project_display_name:=:
  • resource.type:=:
groupBy

string

必需。用于定义要用于分组的素材资源字段的表达式。字符串值应遵循 SQL 语法:逗号分隔的字段列表。例如:“parent,resourceName”。

pageToken

string

最后一个 GroupFindingsResponse 返回的值;该参数表示这是之前的 findings.group 调用的延续,并且系统应返回下一页的数据。

pageSize

integer

单个响应中返回的结果数上限。默认值为 10,最小值为 1,最大值为 1000。

响应正文

如果成功,则响应正文包含一个 GroupFindingsResponse 实例。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview