amazon.aws.cloudwatch_metric_alarm_info 模块 – 收集指定指标的告警信息

注意

此模块是 amazon.aws 集合 (版本 9.0.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，有关详细信息，请参见 要求。

要在 playbook 中使用它，请指定： amazon.aws.cloudwatch_metric_alarm_info。

amazon.aws 5.0.0 中的新增功能

概要

  • 检索指定指标的告警。

要求

执行此模块的主机需要以下要求。

  • python >= 3.6

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

参数

参数

注释

access_key

别名：aws_access_key_id, aws_access_key, ec2_access_key

字符串

AWS 访问密钥 ID。

有关访问令牌的更多信息，请参见 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。

也可以使用 AWS_ACCESS_KEY_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量，优先级依次递减。

aws_access_key 和 profile 选项是互斥的。

为与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。

ec2_access_key 别名已被弃用，并将在 2024-12-01 之后的一个版本中移除。

EC2_ACCESS_KEY 环境变量的支持已被弃用，并将在 2024-12-01 之后的一个版本中移除。

action_prefix

字符串

此参数可用于过滤操作结果，仅显示使用特定告警操作的告警。

alarm_name_prefix

字符串

告警名称前缀，用于检索名称以该前缀开头的告警信息。

不能与 alarm_names 一起使用。

alarm_names

列表 / 元素=字符串

指标的名称。

alarm_type

字符串

指定此参数以返回指标告警或复合告警。

模块默认为返回指标告警，但如果 alarm_type=CompositeAlarm，则可以返回复合告警。

选项

  • "CompositeAlarm"

  • "MetricAlarm" ← (默认)

aws_ca_bundle

路径

验证 SSL 证书时要使用的 CA 证书包的位置。

也可以使用 AWS_CA_BUNDLE 环境变量。

aws_config

字典

用于修改 botocore 配置的字典。

参数可在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。

children_of_alarm_name

字符串

如果指定，则返回有关指定告警名称的“子”告警的信息。

debug_botocore_endpoint_logs

布尔值

使用 botocore.endpoint 日志记录器来解析在任务期间进行的唯一（而不是总数）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的总数列表。

也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选项

  • false ← (默认)

  • true

endpoint_url

别名：ec2_url, aws_endpoint_url, s3_url

字符串

连接到的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。

也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次递减。

ec2_url 和 s3_url 别名已被弃用，并将在 2024-12-01 之后的一个版本中移除。

EC2_URL 环境变量的支持已被弃用，并将在 2024-12-01 之后的一个版本中移除。

parents_of_alarm_name

字符串

如果指定，则返回有关指定告警名称的“父”告警的信息。

profile

别名：aws_profile

字符串

用于身份验证的命名 AWS 配置文件。

有关命名配置文件的更多信息，请参见 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。

也可以使用 AWS_PROFILE 环境变量。

profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项是互斥的。

region

别名：aws_region, ec2_region

字符串

要使用的 AWS 区域。

对于诸如 IAM、Route53 和 CloudFront 之类的全球服务，将忽略 region。

也可以使用AWS_REGION或EC2_REGION环境变量。

更多信息，请参见Amazon AWS文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。

ec2_region别名已弃用，将在2024-12-01之后的一个版本中移除。

对EC2_REGION环境变量的支持已弃用，将在2024-12-01之后的一个版本中移除。

secret_key

别名：aws_secret_access_key, aws_secret_key, ec2_secret_key

字符串

AWS密钥访问密钥。

有关访问令牌的更多信息，请参见 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。

也可以使用AWS_SECRET_ACCESS_KEY、AWS_SECRET_KEY或EC2_SECRET_KEY环境变量，优先级依次递减。

secret_key和profile选项互斥。

为与AWS botocore SDK保持一致，在5.1.0版本中添加了aws_secret_access_key别名。

ec2_secret_key别名已弃用，将在2024-12-01之后的一个版本中移除。

对EC2_SECRET_KEY环境变量的支持已弃用，将在2024-12-01之后的一个版本中移除。

session_token

别名：aws_session_token, security_token, aws_security_token, access_token

字符串

用于临时凭据的AWS STS会话令牌。

有关访问令牌的更多信息，请参见 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。

也可以使用AWS_SESSION_TOKEN、AWS_SECURITY_TOKEN或EC2_SECURITY_TOKEN环境变量，优先级依次递减。

security_token和profile选项互斥。

在3.2.0版本中添加了aws_session_token和session_token别名，并在6.0.0版本中将参数名称从security_token重命名为session_token。

security_token、aws_security_token和access_token别名已弃用，将在2024-12-01之后的一个版本中移除。

对EC2_SECRET_KEY和AWS_SECURITY_TOKEN环境变量的支持已弃用，将在2024-12-01之后的一个版本中移除。

state_value

字符串

如果指定，则仅返回有关当前处于特定状态的警报的信息。

选项

  • "OK"

  • "ALARM"

  • "INSUFFICIENT_DATA"

validate_certs

布尔值

设置为false时，将不会验证与AWS API通信的SSL证书。

强烈建议不要设置validate_certs=false，作为替代方案，请考虑设置aws_ca_bundle。

选项

  • false

  • true ← (默认)

注释

注意

  • 注意：对于模块，环境变量和配置文件是从Ansible的“主机”上下文而不是“控制器”上下文读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从Ansible的“控制器”上下文而不是“主机”上下文读取的。

  • Ansible使用的AWS SDK (boto3)也可能从Ansible“主机”上下文中的配置文件（通常为~/.aws/credentials）读取凭据和其他设置的默认值，例如区域。更多信息，请参见 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: describe the metric alarm based on alarm names
  amazon.aws.cloudwatch_metric_alarm_info:
    alarm_names:
      - my-test-alarm-1
      - my-test-alarm-2

- name: describe the metric alarm based alarm names and state value
  amazon.aws.cloudwatch_metric_alarm_info:
    alarm_names:
      - my-test-alarm-1
      - my-test-alarm-2
    state_value: OK

- name: describe the metric alarm based alarm names prefix
  amazon.aws.cloudwatch_metric_alarm_info:
    alarm_name_prefix: my-test-

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键

描述

metric_alarms

列表 / 元素=字典

收集到的有关指定指标警报的信息。

返回：成功时

actions_enabled

布尔值

指示是否应在警报状态发生任何更改时执行操作。

返回：始终

alarm_actions

列表 / 元素=字符串

当此警报从任何其他状态转换为ALARM状态时要执行的操作。

返回：始终

alarm_arn

字符串

警报的Amazon资源名称（ARN）。

返回：始终

alarm_configuration_updated_timestamp

字符串

上次更新警报配置的时间戳。

返回：始终

alarm_description

字符串

警报的描述。

返回：始终

alarm_name

字符串

警报的唯一名称。

返回：始终

comparison_operator

字符串

比较指定的统计数据和阈值时要使用的算术运算。

返回：始终

datapoints_to_alarm

整数

必须违反才能触发警报的数据点数。

返回：始终

dimensions

列表 / 元素=字典

指标的维度。

返回：始终

name

字符串

维度的名称。

返回：始终

value

字符串

维度的值。

返回：始终

evaluate_low_sample_count_percentile

字符串

仅用于基于百分位的警报。

如果为忽略，则在数据点太少而无法具有统计意义的期间，警报状态不会更改。

如果为评估或未使用此参数，则始终评估警报并可能更改状态。

返回：始终

evaluation_period

整数

将数据与指定阈值进行比较的期间数。

返回：始终

extended_statistic

字符串

与警报关联的指标的百分位数统计数据。

返回：始终

insufficient_data_actions

列表 / 元素=字符串

当此警报从任何其他状态转换为INSUFFICIENT_DATA状态时要执行的操作。

返回：始终

metric_name

字符串

受监控指标的名称（例如CPUUtilization）。

返回：始终

metrics

列表 / 元素=字典

MetricDataQuery 结构的数组，用于基于指标数学表达式的警报。

返回：始终

namespace

字符串

相应命名空间的名称（AWS/EC2、System/Linux等）。

确定它将在CloudWatch中显示的类别。

返回：始终

ok_actions

列表 / 元素=字符串

当此警报从任何其他状态转换为OK状态时要执行的操作。

返回：始终

period

整数

每次评估MetricName中指定的指标时使用的长度（以秒为单位）。

有效值为10、30和60的任何倍数。

返回：始终

state_reason

字符串

警报状态的文本格式说明。

返回：始终

state_reason_data

字符串

警报状态的JSON格式说明。

返回：始终

state_updated_timestamp

字符串

上次更新警报状态的时间戳。

返回：始终

state_value

字符串

警报的状态值。

返回：始终

statistic

字符串

与警报关联的指标的统计数据（非百分位数）。

返回：始终

threshold

浮点数

要与指定统计数据进行比较的值。

返回：始终

threshold_metric_id

字符串

这是用作警报阈值的ANOMALY_DETECTION_BAND函数的ID。

返回：始终

treat_missing_data

字符串

设置警报如何处理缺失的数据点。

返回：始终

unit

字符串

存储指标时使用的单位。

返回：始终

作者

  • Mandar Vijay Kulkarni (@mandar242)