Method: organizations.sources.findings.group

Memfilter temuan organisasi atau sumber dan mengelompokkan temuan tersebut berdasarkan properti yang ditentukan.

Untuk mengelompokkan di semua sumber, berikan - sebagai ID sumber. Contoh: /v1beta1/organizations/{organization_id}/sources/-/findings

Permintaan HTTP


URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama sumber untuk groupBy. Formatnya adalah "organizations/[organization_id]/sources/[source_id]". Untuk groupBy di semua sumber, berikan source_id -. Misalnya: organizations/{organization_id}/sources/-

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "filter": string,
  "groupBy": string,
  "readTime": string,
  "pageToken": string,
  "pageSize": integer
}
Kolom
filter

string

Ekspresi yang menentukan filter yang akan diterapkan di seluruh temuan. Ekspresi ini adalah daftar satu atau beberapa batasan yang digabungkan melalui operator logis AND dan OR. Tanda kurung tidak didukung, dan OR memiliki prioritas lebih tinggi daripada AND.

Batasan memiliki bentuk <field> <operator> <value> dan dapat memiliki karakter - di depannya untuk menunjukkan negasi. Beberapa contoh di antaranya:

  • nama
  • sourceProperties.a_property
  • securityMarks.marks.marka

Operator yang didukung adalah:

  • = untuk semua jenis nilai.
  • >, <, >=, <= untuk nilai bilangan bulat.
  • :, yang berarti pencocokan substring, untuk string.

Jenis nilai yang didukung adalah:

  • literal string dalam tanda kutip.
  • literal bilangan bulat tanpa tanda kutip.
  • literal boolean true dan false tanpa tanda petik.

Misalnya, sourceProperties.size = 100 adalah string filter yang valid.

groupBy

string

Wajib. Ekspresi yang menentukan kolom aset yang akan digunakan untuk pengelompokan (termasuk state). Nilai string harus mengikuti sintaksis SQL: daftar kolom yang dipisahkan koma. Misalnya: "parent,resourceName".

Kolom berikut didukung:

  • resourceName
  • kategori
  • state
  • parent
readTime

string (Timestamp format)

Waktu yang digunakan sebagai titik referensi saat memfilter temuan. Filter ini terbatas pada temuan yang ada pada waktu yang diberikan dan nilainya adalah nilai pada waktu tertentu tersebut. Jika tidak ada, kolom ini akan ditetapkan secara default ke versi NOW API.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

pageToken

string

Nilai yang ditampilkan oleh GroupFindingsResponse terakhir; menunjukkan bahwa ini adalah kelanjutan dari panggilan findings.group sebelumnya, dan bahwa sistem harus menampilkan halaman data berikutnya.

pageSize

integer

Jumlah maksimum hasil yang akan ditampilkan dalam satu respons. Default-nya 10, minimum 1, maksimum 1.000.

Isi respons

Pesan respons untuk pengelompokan menurut temuan.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "groupByResults": [
    {
      object (GroupResult)
    }
  ],
  "readTime": string,
  "nextPageToken": string
}
Kolom
groupByResults[]

object (GroupResult)

Mengelompokkan hasil. Ada elemen untuk setiap kombinasi properti/nilai unik yang ada. Elemen ini berisi jumlah frekuensi kemunculan properti/nilai tertentu tersebut.

readTime

string (Timestamp format)

Waktu yang digunakan untuk mengeksekusi permintaan groupBy.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

nextPageToken

string

Token untuk mengambil halaman hasil berikutnya, atau kosong jika tidak ada lagi hasil.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.