REST Resource: projects.locations.serviceLbPolicies

資源：ServiceLbPolicy

ServiceLbPolicy 包含可套用至 BackendService 的全域負載平衡和流量分配設定。

JSON 表示法 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "loadBalancingAlgorithm": enum (LoadBalancingAlgorithm),
  "autoCapacityDrain": {
    object (AutoCapacityDrain)
  },
  "failoverConfig": {
    object (FailoverConfig)
  }
}
欄位
name

string

ID。ServiceLbPolicy 資源的名稱。符合模式 projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}。
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"。
labels

map (key: string, value: string)

(選用步驟) 與 ServiceLbPolicy 資源相關聯的標籤標記集。

包含 "key": value 組合清單的物件。範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
description

string

(選用步驟) 資源的自由格式文字說明。長度上限為 1024 個字元。
loadBalancingAlgorithm

enum (LoadBalancingAlgorithm)

(選用步驟) 要使用的負載平衡演算法類型。預設行為為 WATERFALL_BY_REGION。
autoCapacityDrain

object (AutoCapacityDrain)

(選用步驟) 設定自動將流量移走，避開相關聯後端服務的健康狀態不良 IG/NEG。
failoverConfig

object (FailoverConfig)

(選用步驟) 與健康狀態相關的容錯移轉設定。

LoadBalancingAlgorithm

要使用的全域負載平衡演算法。

列舉
LOAD_BALANCING_ALGORITHM_UNSPECIFIED 未指定負載平衡演算法類型。
SPRAY_TO_WORLD 根據容量，將流量平均分配至全球所有後端。
SPRAY_TO_REGION 將流量導向至具有端點和容量的最近區域，再溢流至其他區域，並將每個用戶端的流量分散至區域中的所有 MIG/NEG。
WATERFALL_BY_REGION 先將流量導向至有端點和容量的最近區域，再溢流至其他區域。區域內的所有 MIG/NEG 都會平均負載，但每個用戶端可能不會將流量分散至區域內的所有 MIG/NEG。
WATERFALL_BY_ZONE 盡量將流量保留在最靠近用戶端的單一可用區，再溢流至其他可用區。

AutoCapacityDrain

可指定是否應將健康狀態不良的 IG/NEG 納入全域負載平衡和流量轉送考量。

JSON 表示法 
{
  "enable": boolean
}
欄位
enable

boolean

(選用步驟) 如果設為「True」，系統會將健康狀態不良的 IG/NEG 設為已排空。- 如果 IG/NEG 中健康狀態良好的執行個體/端點少於 25%，系統會將 IG/NEG 視為健康狀態不良。- 這個選項絕不會導致後端服務的設定 IG/NEG 耗盡超過 50% 的資源。

FailoverConfig

這個選項可指定以健康狀態為依據的容錯移轉行為。這與網路負載平衡器的 FailoverPolicy 無關。

JSON 表示法 
{
  "failoverHealthThreshold": integer
}
欄位
failoverHealthThreshold

integer

(選用步驟) 達到這個百分比門檻之後，負載平衡器就會開始將流量傳送至容錯移轉後端。如果 MIG/NEG 中的端點百分比小於這個值，系統會盡可能將流量傳送至容錯移轉後端。這個欄位應設為介於 1 至 99 的值。全域外部 HTTP(S) 負載平衡器 (傳統版) 和無 Proxy 服務網格的預設值為 50，其他則為 70。

方法

create

 在指定專案和位置中建立新的 ServiceLbPolicy。

delete

 刪除單一 ServiceLbPolicy。

get

 取得單一 ServiceLbPolicy 的詳細資料。

getIamPolicy

 取得資源的存取權控管政策。

list

 列出指定專案和位置中的 ServiceLbPolicies。

patch

 更新單一 ServiceLbPolicy 的參數。

setIamPolicy

 設定指定資源的存取權控管政策。

testIamPermissions

 傳回呼叫者在指定資源上擁有的權限。