google.cloud.gcp_compute_region_autoscaler_info 模块 – 收集 GCP RegionAutoscaler 的信息
注意
此模块是 google.cloud 集合（版本 1.4.1）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。 它不包含在 ansible-core 中。 要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install google.cloud。 您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：google.cloud.gcp_compute_region_autoscaler_info。
注意
由于违反了 Ansible 的包含要求，google.cloud 集合将从 Ansible 12 中删除。 该集合存在 未解决的健全性测试失败。 有关更多信息，请参阅讨论主题。
概要
收集 GCP RegionAutoscaler 的信息
要求
执行此模块的主机需要满足以下要求。
python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
参数
参数 |
注释 |
|---|---|
如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。 |
|
使用的凭据类型。 选择
|
|
指定您在其中运行此模块的 Ansible 环境。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的用户代理字符串。 |
|
筛选器值对的列表。 此处列出了可用的筛选器 https://cloud.google.com/sdk/gcloud/reference/topic/filters。 列表中的每个附加筛选器都将作为 AND 条件添加（筛选器 1 和筛选器 2）。 |
|
要使用的 Google Cloud Platform 项目。 |
|
实例组所在的区域的 URL。 |
|
要使用的作用域数组 |
|
服务帐户 JSON 文件的内容，可以是字典形式，也可以是表示它的 JSON 字符串。 |
|
如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则可选的服务帐户电子邮件地址。 |
|
如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。 |
注释
注意
对于身份验证，您可以使用
GCP_SERVICE_ACCOUNT_FILE环境变量设置 service_account_file。对于身份验证，您可以使用
GCP_SERVICE_ACCOUNT_CONTENTS环境变量设置 service_account_contents。对于身份验证，您可以使用
GCP_SERVICE_ACCOUNT_EMAIL环境变量设置 service_account_email。对于身份验证，您可以使用
GCP_ACCESS_TOKEN环境变量设置 access_token。对于身份验证，您可以使用
GCP_AUTH_KIND环境变量设置 auth_kind。对于身份验证，您可以使用
GCP_SCOPES环境变量设置 scopes。仅当未设置 playbook 值时，才会使用环境变量值。
service_account_email 和 service_account_file 选项是互斥的。
示例
- name: get info on a region autoscaler
gcp_compute_region_autoscaler_info:
region: us-central1
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
返回值
常见的返回值记录在 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
资源列表 返回： 总是 |
|
自动缩放算法的配置参数。 您可以为一个自动缩放器定义一个或多个策略：cpuUtilization、customMetricUtilizations 和 loadBalancingUtilization。 如果未指定这些参数，则默认情况下将根据 cpuUtilization 自动缩放至 0.6 或 60%。 返回： 成功 |
|
自动缩放器在开始从新实例收集信息之前应等待的秒数。 这可以防止自动缩放器在实例初始化期间收集信息，在此期间收集的利用率将不可靠。 自动缩放器等待的默认时间为 60 秒。 虚拟机初始化时间可能因多种因素而异。 我们建议您测试实例初始化所需的时间。 为此，请创建一个实例并计时启动过程。 返回： 成功 |
|
定义 CPU 利用率策略，该策略允许自动缩放器根据托管实例组的平均 CPU 利用率进行缩放。 返回： 成功 |
|
指示是否启用了基于 CPU 指标的预测性自动缩放。 有效值为： - NONE（默认）。 不使用预测方法。 自动缩放器会缩放组以满足基于实时指标的当前需求。
返回： 成功 |
|
自动缩放器应保持的目标 CPU 利用率。 必须是 (0, 1] 范围内的浮点值。 如果未指定，则默认值为 0.6。 如果 CPU 水平低于目标利用率，自动伸缩器会缩减实例数量，直到达到您指定的最小实例数量，或者直到实例的平均 CPU 利用率达到目标利用率。 如果平均 CPU 高于目标利用率，自动伸缩器会增加实例数量，直到达到您指定的最大实例数量，或者直到平均利用率达到目标利用率。 返回： 成功 |
|
基于自定义指标的自动伸缩配置参数。 返回： 成功 |
|
Stackdriver Monitoring 指标的标识符（类型）。 该指标不能有负值。 该指标的值类型必须为 INT64 或 DOUBLE。 返回： 成功 |
|
自动伸缩器应保持的指标目标值。这必须是一个正值。利用率指标会按比例增加或减少处理请求的虚拟机数量，以匹配指标变化。 例如，用作 utilizationTarget 的一个好的指标是 www.googleapis.com/compute/instance/network/received_bytes_count。 自动伸缩器会努力保持每个实例的这个值恒定。 返回： 成功 |
|
定义如何为 Stackdriver Monitoring 指标表示目标利用率值。 返回： 成功 |
|
基于负载均衡器的自动伸缩配置参数。 返回： 成功 |
|
自动伸缩器应保持的后端容量利用率（在 HTTP(s) 负载均衡配置中设置）的比例。必须是正浮点值。如果未定义，则默认值为 0.8。 返回： 成功 |
|
自动伸缩器可以扩展到的最大实例数量。创建或更新自动伸缩器时，这是必需的。最大副本数不应低于最小副本数。 返回： 成功 |
|
自动伸缩器可以缩减到的最小副本数。这不能小于 0。如果未提供，自动伸缩器将根据允许的最大实例数选择默认值。 返回： 成功 |
|
定义此策略的操作模式。 返回： 成功 |
|
定义缩减控制，以减少由于突发缩减事件导致的响应延迟和中断风险。 返回： 成功 |
|
一个嵌套的对象资源。 返回： 成功 |
|
指定固定数量的虚拟机实例。这必须是一个正整数。 返回： 成功 |
|
指定 0 到 100%（包括 0 和 100%）之间的实例百分比。 例如，为 80% 指定 80。 返回： 成功 |
|
计算建议时，自动伸缩应回顾多长时间，以包括有关如上所述减缓缩减的指令。 返回： 成功 |
|
RFC3339 文本格式的创建时间戳。 返回： 成功 |
|
此资源的可选描述。 返回： 成功 |
|
资源的唯一标识符。 返回： 成功 |
|
资源的名称。名称的长度必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，并且所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。 返回： 成功 |
|
实例组所在的区域的 URL。 返回： 成功 |
|
此自动伸缩器将伸缩的托管实例组的 URL。 返回： 成功 |