REST Resource: projects.locations.vpcFlowLogsConfigs

資源：VpcFlowLogsConfig

產生虛擬私有雲流量記錄的設定。

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,
  "targetResourceState": enum (TargetResourceState),

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

string

ID。使用下列格式，輸入設定的專屬名稱：projects/{projectId}/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

(選用步驟) 使用者提供的虛擬私有雲流量記錄設定說明。長度上限為 512 個半形字元。
state

enum (State)

(選用步驟) 虛擬私有雲流量記錄設定的狀態。預設值為 ENABLED。建立新設定時，必須啟用該設定。將 state 設為 DISABLED 會暫停產生這項設定的記錄。
aggregationInterval

enum (AggregationInterval)

(選用步驟) 記錄檔的匯總間隔。預設值為 INTERVAL_5_SEC。
flowSampling

number

(選用步驟) 欄位的值必須介於 [0, 1] 之間。虛擬私有雲流量記錄檔的取樣率，其中 1.0 表示會回報所有收集到的記錄。取樣率不得設為 0.0。如要停用 VPC 流程記錄，請改用狀態欄位。預設值為 1.0。
metadata

enum (Metadata)

(選用步驟) 設定是否應將所有、無或部分中繼資料欄位新增至回報的 VPC 流量記錄。預設值為 INCLUDE_ALL_METADATA。
filterExpr

string

(選用步驟) 用於定義應記錄哪些 VPC 流量記錄檔的匯出篩選器。
targetResourceState

enum (TargetResourceState)

僅供輸出。診斷位元：描述已設定目標資源的狀態，以利診斷。
聯集欄位 target_resource。參照設定範圍的資源。也就是記錄流量的範圍。目標資源必須與設定屬於相同專案。target_resource 只能是下列其中一項：
interconnectAttachment

string

系統會記錄互連網路附件的流量。格式：projects/{projectId}/regions/{region}/interconnectAttachments/{name}
vpnTunnel

string

系統會記錄 VPN 通道的流量。格式：projects/{projectId}/regions/{region}/vpnTunnels/{name}

狀態

判斷這項設定是否會產生記錄。

列舉
STATE_UNSPECIFIED 如未指定，則預設為 ENABLED。
ENABLED 當值為 ENABLED 時，這項設定會產生記錄。
DISABLED 如果設為「DISABLED」，這項設定就不會產生記錄。

AggregationInterval

切換匯總間隔，以 5 元組收集流程記錄。

列舉
AGGREGATION_INTERVAL_UNSPECIFIED 如未指定，則預設為 INTERVAL_5_SEC。
INTERVAL_5_SEC 以 5 秒的間隔匯總記錄檔。
INTERVAL_30_SEC 以 30 秒的間隔匯總記錄。
INTERVAL_1_MIN 以 1 分鐘的間隔匯總記錄。
INTERVAL_5_MIN 以 5 分鐘為間隔匯總記錄。
INTERVAL_10_MIN 以 10 分鐘的間隔匯總記錄。
INTERVAL_15_MIN 以 15 分鐘的間隔匯總記錄。

中繼資料

設定要納入哪些記錄欄位。

列舉
METADATA_UNSPECIFIED 如未指定，則預設為 INCLUDE_ALL_METADATA。
INCLUDE_ALL_METADATA 納入所有中繼資料欄位。
EXCLUDE_ALL_METADATA 排除所有中繼資料欄位。
CUSTOM_METADATA 只包含自訂欄位 (在 metadataFields 中指定)。

TargetResourceState

用於診斷位元，可用於指定目標資源的選用狀態。

列舉
TARGET_RESOURCE_STATE_UNSPECIFIED 未指定目標資源狀態。
TARGET_RESOURCE_EXISTS 表示目標資源存在。
TARGET_RESOURCE_DOES_NOT_EXIST 表示目標資源不存在。

方法

create

 建立新的 VpcFlowLogsConfig。

delete

 刪除特定 VpcFlowLogsConfig。

get

 取得特定 VpcFlowLogsConfig 的詳細資料。

list

 列出指定專案中的所有 VpcFlowLogsConfigs。

patch

 更新現有的 VpcFlowLogsConfig。