Method: organizations.assets.group

Memfilter aset organisasi dan mengelompokkan aset tersebut berdasarkan properti yang ditentukan.

Permintaan HTTP


URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama organisasi untuk groupBy. Formatnya adalah "organizations/[organization_id]".

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

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

string

Ekspresi yang menentukan filter yang akan diterapkan di seluruh aset. Ekspresi ini adalah daftar nol 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. Kolom dipetakan ke kolom yang ditentukan dalam resource Aset. Beberapa contoh di antaranya:

  • nama
  • securityCenterProperties.resource_name
  • resourceProperties.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, resourceProperties.size = 100 adalah string filter yang valid.
groupBy

string

Wajib. Ekspresi yang menentukan kolom aset yang akan digunakan untuk pengelompokan. Nilai string harus mengikuti sintaksis SQL: daftar kolom yang dipisahkan koma. Misalnya: "securityCenterProperties.resource_project,securityCenterProperties.project".

Kolom berikut didukung jika compareDuration tidak ditetapkan:

  • securityCenterProperties.resource_project
  • securityCenterProperties.resource_type
  • securityCenterProperties.resource_parent

Kolom berikut didukung saat compareDuration ditetapkan:

  • securityCenterProperties.resource_type
compareDuration

string (Duration format)

Saat compareDuration ditetapkan, properti "state" Aset diperbarui untuk menunjukkan apakah aset ditambahkan, dihapus, atau tetap ada selama jangka waktu compareDuration yang mendahului readTime. Ini adalah waktu antara (readTime - compareDuration) dan readTime.

Nilai status berasal dari keberadaan aset pada dua titik waktu. Perubahan status perantara antara kedua waktu tersebut tidak memengaruhi hasilnya. Misalnya, hasilnya tidak akan terpengaruh jika aset dihapus dan dibuat ulang.

Nilai "state" yang mungkin jika compareDuration ditentukan:

  • "ADDED": menunjukkan bahwa aset tidak ada sebelum compareDuration, tetapi ada pada reference_time.
  • "REMOVED": menunjukkan bahwa aset ada di awal compareDuration, tetapi tidak ada di reference_time.
  • "ACTIVE": menunjukkan bahwa aset ada di awal dan akhir jangka waktu yang ditentukan oleh compareDuration dan reference_time.

Kolom ini diabaikan jika state bukan kolom di groupBy.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".
readTime

string (Timestamp format)

Waktu yang digunakan sebagai titik referensi saat memfilter aset. Filter ini terbatas pada aset 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 GroupAssetsResponse terakhir; menunjukkan bahwa ini adalah kelanjutan dari panggilan assets.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 aset.

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.