REST Resource: organizations.locations.vpcFlowLogsConfigs

משאב: VpcFlowLogsConfig

הגדרה ליצירת יומני זרימה של VPC.

ייצוג ב-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.
}
שדות
name

string

מזהה. השם הייחודי של ההגדרה. השם יכול להיות באחת מהצורות הבאות:

  • להגדרות ברמת הפרויקט: projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

  • להגדרות ברמת הארגון: organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}
metadataFields[]

string

זה שינוי אופציונלי. שדות מטא-נתונים בהתאמה אישית שרוצים לכלול ביומני הזרימה של ה-VPC שדווחו. אפשר לציין את הפרמטר הזה רק אם הערך של metadata הוא CUSTOM_METADATA.
labels

map (key: string, value: string)

זה שינוי אופציונלי. תוויות משאבים שמייצגות מטא-נתונים שסופקו על ידי משתמשים.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

פלט בלבד. השעה שבה נוצרה ההגדרה.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

פלט בלבד. השעה שבה ההגדרה עודכנה.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
description

string

זה שינוי אופציונלי. התיאור שסופק על ידי המשתמש של הגדרת VPC Flow Logs. 512 תווים לכל היותר.
state

enum (State)

זה שינוי אופציונלי. הסטטוס של ההגדרה של VPC Flow Log. ערך ברירת המחדל הוא ENABLED. כשיוצרים הגדרה חדשה, צריך להפעיל אותה. הגדרת state=DISABLED תשבית את יצירת היומן עבור ההגדרה הזו.
aggregationInterval

enum (AggregationInterval)

זה שינוי אופציונלי. מרווח הצבירה של היומנים. ערך ברירת המחדל הוא INTERVAL_5_SEC.
flowSampling

number

זה שינוי אופציונלי. הערך בשדה צריך להיות בטווח (0, 1]. קצב הדגימה של VPC Flow Logs, כאשר 1.0 מציין שכל היומנים שנאספו מדווחים. אסור להגדיר את שיעור הדגימה ל-0.0. אם רוצים להשבית את היומנים של תנועת הנתונים ב-VPC, צריך להשתמש בשדה state במקום זאת. ערך ברירת המחדל הוא 1.0.
metadata

enum (Metadata)

זה שינוי אופציונלי. הגדרה שקובעת אם להוסיף ליומני הזרימה של ה-VPC את כל שדות המטא-נתונים, אף אחד מהם או קבוצת משנה שלהם. ערך ברירת המחדל הוא INCLUDE_ALL_METADATA.
filterExpr

string

זה שינוי אופציונלי. מסנן הייצוא משמש להגדרת יומני הזרימה של ה-VPC שצריך לרשום ביומן.
crossProjectMetadata

enum (CrossProjectMetadata)

זה שינוי אופציונלי. ההגדרה קובעת אם לכלול בהערות את הפרויקטים שחוצים את הגבולות של הפרויקט הנוכחי. השדה הזה זמין רק להגדרות של הארגון. אם לא מציינים את ההגדרה הזו בהגדרות הארגון, היא תוגדר כ-CROSS_PROJECT_METADATA_ENABLED.
targetResourceState

enum (TargetResourceState)

פלט בלבד. תיאור של המצב של משאב היעד שהוגדר למטרות אבחון.
שדה איחוד target_resource. הפניה למשאב של היקף ההגדרה. כלומר, ההיקף שממנו מתועדת התנועה. משאב היעד חייב להיות שייך לאותו פרויקט כמו ההגדרה. השדה הזה לא נתמך בהגדרות ברמת הארגון. הערך target_resource יכול להיות רק אחד מהבאים:
network

string

תנועת הנתונים תתועד ממכונות וירטואליות, ממנהרות VPN ומחיבורי Interconnect ברשת. פורמט: projects/{projectId}/global/networks/{name}
subnet

string

תנועה תתועד ממכונות וירטואליות ברשת המשנה. פורמט: projects/{projectId}/regions/{region}/subnetworks/{name}
interconnectAttachment

string

התנועה תתועד מהקובץ המצורף של Interconnect. פורמט: projects/{projectId}/regions/{region}/interconnectAttachments/{name}
vpnTunnel

string

התנועה תתועד ממנהרת ה-VPN. פורמט: projects/{projectId}/regions/{region}/vpnTunnels/{name}

מדינה

המדיניות קובעת אם התצורה הזו תיצור יומנים.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED אם לא מציינים ערך, ברירת המחדל היא ENABLED.
ENABLED כשההגדרה הזו מופעלת, היא יוצרת יומנים.
DISABLED כשההגדרה מושבתת, ההגדרה הזו לא תיצור יומנים.

AggregationInterval

החלפה של מרווח הצבירה לאיסוף יומני זרימה לפי 5-tuple.

טיפוסים בני מנייה (enum)
AGGREGATION_INTERVAL_UNSPECIFIED אם לא מציינים ערך, ברירת המחדל היא INTERVAL_5_SEC.
INTERVAL_5_SEC יומנים מצטברים במרווחי זמן של 5 שניות.
INTERVAL_30_SEC צבירת יומנים במרווחי זמן של 30 שניות.
INTERVAL_1_MIN צבירת יומנים במרווחים של דקה.
INTERVAL_5_MIN צבירת יומנים במרווחים של 5 דקות.
INTERVAL_10_MIN צבירת יומנים במרווחים של 10 דקות.
INTERVAL_15_MIN צבירת יומנים במרווחים של 15 דקות.

מטא-נתונים

ההגדרה הזו קובעת אילו שדות יומן ייכללו.

טיפוסים בני מנייה (enum)
METADATA_UNSPECIFIED אם לא מציינים ערך, ברירת המחדל היא INCLUDE_ALL_METADATA.
INCLUDE_ALL_METADATA לכלול את כל שדות המטא-נתונים.
EXCLUDE_ALL_METADATA החרגה של כל שדות המטא-נתונים.
CUSTOM_METADATA הכללה רק של שדות מותאמים אישית (שצוינו ב-metadataFields).

CrossProjectMetadata

ההגדרה קובעת אם לכלול בהערות את הפרויקטים שחוצים את הגבולות של הפרויקט הנוכחי. ההגדרות של הפרויקט תמיד יכללו את CROSS_PROJECT_METADATA_DISABLED.

טיפוסים בני מנייה (enum)
CROSS_PROJECT_METADATA_UNSPECIFIED אם לא מציינים את הערך, ברירת המחדל היא CROSS_PROJECT_METADATA_ENABLED.
CROSS_PROJECT_METADATA_ENABLED אם CROSS_PROJECT_METADATA_ENABLED, מטא-נתונים מפרויקטים אחרים ייכללו ביומנים.
CROSS_PROJECT_METADATA_DISABLED אם הערך של CROSS_PROJECT_METADATA_DISABLED הוא True, מטא-נתונים מפרויקטים אחרים לא ייכללו ביומנים.

TargetResourceState

פלט בלבד. למטרות אבחון, המדד מציין אם משאב היעד קיים.

טיפוסים בני מנייה (enum)
TARGET_RESOURCE_STATE_UNSPECIFIED לא צוין סטטוס של משאב היעד.
TARGET_RESOURCE_EXISTS מציין שמשאב היעד קיים.
TARGET_RESOURCE_DOES_NOT_EXIST מציין שמשאב היעד לא קיים.

Methods

create

 יוצרת VpcFlowLogsConfig חדש.

delete

 מחיקה של VpcFlowLogsConfig ספציפי.

get

 קבלת הפרטים של VpcFlowLogsConfig ספציפי.

list

 רשימה של כל VpcFlowLogsConfigs בארגון נתון.

patch

 מעדכן VpcFlowLogsConfig קיים.