Method: projects.locations.vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs

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

בקשת HTTP

GET https://networkmanagement.googleapis.com/v1beta1/{parent=projects/*/locations/*}/vpcFlowLogsConfigs:showEffectiveFlowLogsConfigs

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. משאב ההורה של VpcFlowLogsConfig, שמוגדר בפורמט הבא: projects/{projectId}/locations/global

כדי לתת הרשאה, צריך את הרשאת IAM הבאה במשאב שצוין parent:

  • networkmanagement.vpcflowlogsconfigs.list

פרמטרים של שאילתה

פרמטרים
resource

string

חובה. המשאב שאליו רוצים לקבל את ההגדרה האפקטיבית של VPC Flow Logs. המשאב חייב להיות שייך לאותו פרויקט כמו ההורה. המשאב חייב להיות רשת, רשת משנה, חיבור Interconnect, מנהרת VPN או פרויקט.
pageSize

integer

זה שינוי אופציונלי. מספר התוצאות EffectiveVpcFlowLogsConfigs להחזרה. ברירת המחדל היא 30.
pageToken

string

זה שינוי אופציונלי. טוקן של דף משאילתה קודמת, כפי שמוחזר ב-nextPageToken.
filter

string

זה שינוי אופציונלי. רשימה של EffectiveVpcFlowLogsConfigs שתואמים לביטוי הסינון. ביטוי מסנן צריך להשתמש באופרטורים לוגיים נתמכים של CEL.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

תשובה לשיטה vpcFlowLogsConfigs.showEffectiveFlowLogsConfigs.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "effectiveFlowLogsConfigs": [
    {
      object (EffectiveVpcFlowLogsConfig)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
שדות
effectiveFlowLogsConfigs[]

object (EffectiveVpcFlowLogsConfig)

רשימה של הגדרות אפקטיביות של VPC Flow Logs.
nextPageToken

string

אסימון דף לאחזור של קבוצת ההגדרות הבאה.
unreachable[]

string

מיקומים שלא ניתן להגיע אליהם (כשמבצעים שאילתה לגבי כל המיקומים באמצעות -).

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

ניתן למצוא מידע נוסף כאן: Authentication Overview.

EffectiveVpcFlowLogsConfig

הגדרה ליצירת תגובה לבקשה GetEffectiveVpcFlowLogsConfig.

ייצוג ב-JSON 
{
  "name": string,
  "metadataFields": [
    string
  ],
  "state": enum (State),
  "aggregationInterval": enum (AggregationInterval),
  "flowSampling": number,
  "metadata": enum (Metadata),
  "filterExpr": string,
  "crossProjectMetadata": enum (CrossProjectMetadata),

  // 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.
  "scope": enum (Scope)
}
שדות
name

string

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

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

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

  • בהגדרת מחשוב, השם יהיה הנתיב של רשת המשנה: projects/{projectId}/regions/{region}/subnetworks/{subnet_id}
metadataFields[]

string

שדות מטא-נתונים בהתאמה אישית שרוצים לכלול ביומני הזרימה של ה-VPC שדווחו. אפשר לציין את הפרמטר הזה רק אם הערך של metadata הוא CUSTOM_METADATA.
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.
שדה איחוד 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}
scope

enum (Scope)

מציין את היקף ההגדרה (למשל, רשת משנה, רשת, ארגון...).

היקף

ההיקף של הגדרת יומן התנועה הזו.

טיפוסים בני מנייה (enum)
SCOPE_UNSPECIFIED לא צוין היקף הרשאות.
SUBNET משאב היעד הוא רשת משנה (Network Management API).
COMPUTE_API_SUBNET משאב היעד הוא רשת משנה, וההגדרה מגיעה מ-Compute API.
NETWORK משאב היעד הוא רשת.
VPN_TUNNEL משאב היעד הוא מנהרת VPN.
INTERCONNECT_ATTACHMENT משאב היעד הוא קובץ מצורף של קישוריות בין רשתות.
ORGANIZATION ההגדרה חלה על כל הארגון.