REST Resource: projects.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}

Methods

create

 יוצרת VpcFlowLogsConfig חדש.

delete

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

get

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

list

 מציגה רשימה של כל VpcFlowLogsConfigs בפרויקט נתון.

patch

 מעדכן VpcFlowLogsConfig קיים.

queryOrgVpcFlowLogsConfigs

 הפונקציה QueryOrgVpcFlowLogsConfigs מחזירה רשימה של כל ההגדרות של יומני זרימה של VPC ברמת הארגון שרלוונטיות לפרויקט שצוין.

showEffectiveFlowLogsConfigs

 הפונקציה ShowEffectiveFlowLogsConfigs מחזירה רשימה של כל ההגדרות של יומני הזרימה של VPC שרלוונטיות למשאב שצוין.