REST Resource: organizations.locations.vpcFlowLogsConfigs

Resource: VpcFlowLogsConfig

Konfigurasi untuk menghasilkan Log Aliran VPC.

Representasi JSON 
{
  "name": string,
  "metadataFields": [
    string
  ],
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "description": string,
  "state": enum (State),
  "aggregationInterval": enum (AggregationInterval),
  "flowSampling": number,
  "metadata": enum (Metadata),
  "filterExpr": string,
  "crossProjectMetadata": enum (CrossProjectMetadata),
  "targetResourceState": enum (TargetResourceState),

  // Union field target_resource can be only one of the following:
  "network": string,
  "subnet": string,
  "interconnectAttachment": string,
  "vpnTunnel": string
  // End of list of possible types for union field target_resource.
}
Kolom
name

string

ID. Nama unik konfigurasi. Nama dapat memiliki salah satu bentuk berikut:

  • Untuk konfigurasi tingkat project: projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

  • Untuk konfigurasi tingkat organisasi: organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}
metadataFields[]

string

Opsional. Kolom metadata kustom yang akan disertakan dalam log aliran VPC yang dilaporkan. Hanya dapat ditentukan jika "metadata" disetel ke CUSTOM_METADATA.
labels

map (key: string, value: string)

Opsional. Label resource untuk merepresentasikan metadata yang disediakan pengguna.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Hanya output. Waktu pembuatan konfigurasi.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. 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".
updateTime

string (Timestamp format)

Hanya output. Waktu konfigurasi diperbarui.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. 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".
description

string

Opsional. Deskripsi konfigurasi Log Aliran VPC yang diberikan pengguna. Maksimum 512 karakter.
state

enum (State)

Opsional. Status konfigurasi Log Aliran VPC. Nilai defaultnya adalah ENABLED. Saat membuat konfigurasi baru, konfigurasi tersebut harus diaktifkan. Menetapkan state=DISABLED akan menjeda pembuatan log untuk konfigurasi ini.
aggregationInterval

enum (AggregationInterval)

Opsional. Interval agregasi untuk log. Nilai defaultnya adalah INTERVAL_5_SEC.
flowSampling

number

Opsional. Nilai kolom ini harus dalam (0, 1]. Frekuensi pengambilan sampel Log Aliran VPC, dengan 1,0 berarti semua log yang dikumpulkan dilaporkan. Menetapkan rasio pengambilan sampel ke 0,0 tidak diizinkan. Jika Anda ingin menonaktifkan Log Aliran VPC, gunakan kolom status. Nilai defaultnya adalah 1,0.
metadata

enum (Metadata)

Opsional. Mengonfigurasi apakah semua, tidak ada, atau sebagian kolom metadata harus ditambahkan ke log aliran VPC yang dilaporkan. Nilai defaultnya adalah INCLUDE_ALL_METADATA.
filterExpr

string

Opsional. Filter ekspor yang digunakan untuk menentukan Log Aliran VPC mana yang harus dicatat.
crossProjectMetadata

enum (CrossProjectMetadata)

Opsional. Menentukan apakah akan menyertakan anotasi lintas project dalam log. Kolom ini hanya tersedia untuk konfigurasi organisasi. Jika tidak ditentukan dalam konfigurasi organisasi, akan ditetapkan ke CROSS_PROJECT_METADATA_ENABLED.
targetResourceState

enum (TargetResourceState)

Hanya output. Menjelaskan status resource target yang dikonfigurasi untuk tujuan diagnostik.
Kolom union target_resource. Referensi ke resource cakupan konfigurasi. Artinya, cakupan tempat traffic dicatat ke dalam log. Resource target harus termasuk dalam project yang sama dengan konfigurasi. Kolom ini tidak didukung untuk konfigurasi tingkat organisasi. target_resource hanya ada berupa salah satu diantara berikut:
network

string

Traffic akan dicatat dari VM, tunnel VPN, dan Lampiran Interconnect dalam jaringan. Format: projects/{projectId}/global/networks/{name}
subnet

string

Traffic akan dicatat dari VM dalam subnetwork. Format: projects/{projectId}/regions/{region}/subnetworks/{name}
interconnectAttachment

string

Traffic akan dicatat dari Lampiran Interconnect. Format: projects/{projectId}/regions/{region}/interconnectAttachments/{name}
vpnTunnel

string

Traffic akan dicatat dari Tunnel VPN. Format: projects/{projectId}/regions/{region}/vpnTunnels/{name}

Negara bagian/Provinsi

Menentukan apakah konfigurasi ini akan membuat log.

Enum
STATE_UNSPECIFIED Jika tidak ditentukan, defaultnya adalah ENABLED.
ENABLED Jika AKTIF, konfigurasi ini akan menghasilkan log.
DISABLED Jika DINONAKTIFKAN, konfigurasi ini tidak akan menghasilkan log.

AggregationInterval

Mengganti interval agregasi untuk mengumpulkan log alur menurut 5-tuple.

Enum
AGGREGATION_INTERVAL_UNSPECIFIED Jika tidak ditentukan, defaultnya adalah INTERVAL_5_SEC.
INTERVAL_5_SEC Menggabungkan log dalam interval 5 detik.
INTERVAL_30_SEC Menggabungkan log dalam interval 30 detik.
INTERVAL_1_MIN Menggabungkan log dalam interval 1 menit.
INTERVAL_5_MIN Menggabungkan log dalam interval 5 menit.
INTERVAL_10_MIN Menggabungkan log dalam interval 10 menit.
INTERVAL_15_MIN Menggabungkan log dalam interval 15 menit.

Metadata

Mengonfigurasi kolom log mana yang akan disertakan.

Enum
METADATA_UNSPECIFIED Jika tidak ditentukan, defaultnya adalah INCLUDE_ALL_METADATA.
INCLUDE_ALL_METADATA Sertakan semua kolom metadata.
EXCLUDE_ALL_METADATA Mengecualikan semua kolom metadata.
CUSTOM_METADATA Hanya menyertakan kolom kustom (ditentukan dalam metadataFields).

CrossProjectMetadata

Menentukan apakah akan menyertakan anotasi lintas project dalam log. Konfigurasi project akan selalu memiliki CROSS_PROJECT_METADATA_DISABLED.

Enum
CROSS_PROJECT_METADATA_UNSPECIFIED Jika tidak ditentukan, defaultnya adalah CROSS_PROJECT_METADATA_ENABLED.
CROSS_PROJECT_METADATA_ENABLED Jika CROSS_PROJECT_METADATA_ENABLED, metadata dari project lain akan disertakan dalam log.
CROSS_PROJECT_METADATA_DISABLED Jika CROSS_PROJECT_METADATA_DISABLED, metadata dari project lain tidak akan disertakan dalam log.

TargetResourceState

Hanya output. Menunjukkan apakah target resource ada, untuk tujuan diagnostik.

Enum
TARGET_RESOURCE_STATE_UNSPECIFIED Status resource target tidak ditentukan.
TARGET_RESOURCE_EXISTS Menunjukkan bahwa resource target ada.
TARGET_RESOURCE_DOES_NOT_EXIST Menunjukkan bahwa resource target tidak ada.

Metode

create

 Membuat VpcFlowLogsConfig baru.

delete

 Menghapus VpcFlowLogsConfig tertentu.

get

 Mendapatkan detail VpcFlowLogsConfig tertentu.

list

 Mencantumkan semua VpcFlowLogsConfigs dalam organisasi tertentu.

patch

 Memperbarui VpcFlowLogsConfig yang ada.