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

必須。ServiceLbPolicy リソースの名前。パターン projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name} と一致します。
createTime

string (Timestamp format)

出力専用。この ServiceLbPolicy リソースが作成されたときのタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

出力専用。この ServiceLbPolicy リソースが最後に更新されたタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
labels

map (key: string, value: string)

省略可。ServiceLbPolicy リソースに関連付けられたラベルタグのセット。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
description

string

省略可。リソースのフリーテキストの説明。最大長は 1,024 文字です。
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) ロードバランサ（従来型）とプロキシレス サービス メッシュの場合は 50、それ以外は 70 です。

メソッド

create

 指定されたプロジェクトとロケーションで新しい ServiceLbPolicy を作成します。

delete

 1 つの ServiceLbPolicy を削除します。

get

 1 つの ServiceLbPolicy の詳細を取得します。

getIamPolicy

 リソースのアクセス制御ポリシーを取得します。

list

 指定されたプロジェクトとロケーションの ServiceLbPolicy を一覧で表示します。

patch

 単一の ServiceLbPolicy のパラメータを更新します。

setIamPolicy

 指定したリソースにアクセス制御ポリシーを設定します。

testIamPermissions

 呼び出し元が指定されたリソース上で持つ権限を返します。