Method: projects.sources.findings.group

조직 또는 소스의 발견 항목을 필터링하고 지정된 속성별로 그룹화합니다.

모든 소스를 기준으로 그룹화하려면 소스 ID로 -를 제공합니다. 예: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{projectId}/sources/-/findings

HTTP 요청


URL은 gRPC 트랜스코딩 구문을 사용합니다.

경로 매개변수

매개변수
parent

string

필수 입력란입니다. groupBy할 소스의 이름입니다. 형식은 organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], projects/[projectId]/sources/[source_id]입니다. 모든 소스에서 그룹화하려면 source_id를 -로 지정합니다. 예: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- 또는 projects/{projectId}/sources/-

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "filter": string,
  "groupBy": string,
  "readTime": string,
  "compareDuration": string,
  "pageToken": string,
  "pageSize": integer
}
필드
filter

string

발견 항목 전체에 적용할 필터를 정의하는 표현식입니다. 이 표현식은 논리 연산자 AND 및 OR를 통해 결합된 하나 이상의 제한사항 목록입니다. 괄호가 지원되며 OR는 AND보다 우선순위가 높습니다.

제약조건은 <field> <operator> <value> 형식이며 앞에 - 문자가 있어 부정을 나타낼 수 있습니다. 예를 들면 다음과 같습니다.

  • name
  • sourceProperties.a_property
  • securityMarks.marks.marka

지원되는 연산자는 다음과 같습니다.

  • 모든 값 유형의 경우 =입니다.
  • 정수 값: >, <, >=, <=
  • :: 문자열의 하위 문자열 일치를 의미합니다.

지원되는 값 유형은 다음과 같습니다.

  • 문자열 리터럴을 따옴표로 묶습니다.
  • 따옴표가 없는 정수 리터럴
  • 따옴표가 없는 불리언 리터럴 true 및 false

다음과 같은 필드 및 연산자 조합이 지원됩니다.

  • 이름: =
  • 상위 요소: =, :
  • resourceName: =, :
  • 상태: =, :
  • 카테고리: =, :
  • externalUri: =, :
  • eventTime: =, >, <, >=, <=

사용법: 에포크 이후 밀리초 또는 RFC3339 문자열이어야 합니다. 예: eventTime = "2019-06-10T16:07:18-07:00" eventTime = 1560208038000

  • 심각도: =, :
  • workflowState: =, :
  • securityMarks.marks: =, :
  • sourceProperties: =, :, >, <, >=, <=

예를 들어 sourceProperties.size = 100은 유효한 필터 문자열입니다.

빈 문자열에 부분 일치를 사용하여 기존 속성을 기반으로 필터링합니다. sourceProperties.my_property : ""

빈 문자열에 대한 부정 부분 일치를 사용하여 존재하지 않는 속성을 기반으로 필터링합니다. -sourceProperties.my_property : ""

  • resource:
  • resource.name: =, :
  • resource.parent_name: =, :
  • resource.parent_display_name: =, :
  • resource.project_name: =, :
  • resource.project_display_name: =, :
  • resource.type: =, :
groupBy

string

필수 입력란입니다. 그룹화에 사용할 애셋 필드를 정의하는 표현식입니다 (stateChange 포함). 문자열 값은 SQL 구문, 즉 쉼표로 구분된 필드 목록을 따라야 합니다. 예: 'parent,resourceName'

compareDuration이 설정된 경우 다음 필드가 지원됩니다.

  • stateChange
readTime
(deprecated)

string (Timestamp format)

발견 항목을 필터링할 때 참조점으로 사용되는 시간입니다. 필터는 제공된 시간에 존재하는 발견 항목으로 제한되며 값은 해당 시간의 값입니다. 이 필드가 없으면 기본값은 API의 NOW 버전입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 자릿수가 0, 3, 6 또는 9인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
compareDuration
(deprecated)

string (Duration format)

compareDuration이 설정되면 GroupResult의 'stateChange' 속성이 업데이트되어 발견 항목의 상태가 변경되었는지, 발견 항목의 상태가 변경되지 않았는지 또는 readTime 이전의 compareDuration 시간 동안 발견 항목이 추가되었는지 나타냅니다. (readTime - compareDuration)과 readTime 사이의 시간입니다.

stateChange 값은 두 시점의 발견 항목의 존재 여부와 상태를 기반으로 파생됩니다. 두 시점 사이의 중간 상태 변경은 결과에 영향을 미치지 않습니다. 예를 들어 발견 항목을 비활성화했다가 다시 활성화해도 결과는 영향을 받지 않습니다.

compareDuration이 지정된 경우 가능한 'stateChange' 값:

  • 'CHANGED': 발견 항목이 compareDuration 시작 시 존재했으며 지정된 필터와 일치했지만 readTime에서 상태가 변경되었음을 나타냅니다.
  • 'UNCHANGED': 발견 항목이 compareDuration 시작 시점에 존재했으며 지정된 필터와 일치하고 readTime 시점에 상태가 변경되지 않았음을 나타냅니다.
  • 'ADDED': 발견 항목이 지정된 필터와 일치하지 않거나 compareDuration 시작 시에는 없고 readTime에는 있었음을 나타냅니다.
  • 'REMOVED': 발견 항목이 있었고 compareDuration 시작 시 필터와 일치했지만 readTime의 필터와 일치하지 않았음을 나타냅니다.

compareDuration이 지정되지 않은 경우 가능한 유일한 stateChange는 'UNUSED'이며, 이는 readTime에 있는 모든 발견 항목에 대해 설정된 stateChange입니다.

이 필드가 설정된 경우 stateChange는 groupBy에 지정된 필드여야 합니다.

소수점 아래가 최대 9자리까지이고 's'로 끝나는 초 단위 기간입니다. 예를 들면 "3.5s"입니다.
pageToken

string

마지막 GroupFindingsResponse에서 반환한 값입니다. 이 값은 이전 findings.group 호출의 연속이며 시스템에서 다음 데이터 페이지를 반환해야 함을 나타냅니다.
pageSize

integer

단일 응답에서 반환할 최대 결과 수입니다. 기본값은 10, 최소는 1, 최대는 1,000입니다.

응답 본문

성공한 경우 응답 본문에 GroupFindingsResponse의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 Authentication Overview를 참고하세요.