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

注意

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

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

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

要在剧本中使用它，请指定：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 回调输出到剧本期间制作的总列表。

也可以使用 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 保持一致，aws_secret_access_key 别名在 5.1.0 版本中添加。

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 选项互斥。

别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数在 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

字符串

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

如果为 ignore，则警报状态在数据点太少而无法进行统计显著的期间不会更改。

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

返回: 总是

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)