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)

仅限输出。创建此资源的时间戳。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

仅限输出。上次更新此资源的时间戳。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"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

可选。资源的自由文本说明。长度上限为 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) 负载均衡器(经典版)和无代理服务网格的默认值为 50,其他服务的默认值为 70。

方法

create

在给定的项目和位置中创建新的 ServiceLbPolicy。

delete

删除单个 ServiceLbPolicy。

get

获取单个 ServiceLbPolicy 的详细信息。

getIamPolicy

获取资源的访问权限控制政策。

list

列出给定项目和位置中的 ServiceLbPolicy。

patch

更新单个 ServiceLbPolicy 的参数。

setIamPolicy

针对指定资源设置访问权限控制政策。

testIamPermissions

返回调用者对指定资源拥有的权限。