访问 Amazon Health API - Amazon Health
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

访问 Amazon Health API

Amazon Health 是一种 RESTful Web 服务,它使用 HTTPS 进行传输,并采用 JSON 作为消息序列化格式。您的应用程序代码可以直接向 Amazon Health API 发送请求。在您直接使用 REST API 时,您必须编写必要的代码来对您的请求签名以及验证您的请求。有关 Amazon Health 操作和参数的更多信息,请参阅 Amazon Health API 参考

注意

您必须拥有 Amazon Web Services Support 的商业、Enterprise On-Ramp 或企业 Support 计划才能使用 Amazon Health API。如果您使用没有商业、Enterprise On-Ramp 或企业 Support 计划的 Amazon 账户调用 Amazon Health API,则会收到 SubscriptionRequiredException 错误。

您可以使用 Amazon SDK 封装 Amazon Health REST API 调用,从而简化应用程序开发。您指定 Amazon 证书后,这些库会处理您的身份验证和请求登录事宜。

Amazon Health 还可以在 Amazon Web Services Management Console 中提供 Amazon Health 控制面板,您可以用来查看并搜索事件和受影响的实体。请参阅 开始使用您的 Amazon Health 控制面板 – 您的账户运行状况

端点

Amazon HealthAPI 遵循 多区域应用程序架构,并且在主动-被动配置中具有两个区域端点。为了支持主动-被动 DNS 故障转移,Amazon Health 提供了一个全局端点。您可以在全局端点上执行 DNS 查找,以确定主动端点和相应的签名 Amazon 区域。这可以帮助您了解要在代码中使用哪个端点,以便您可以从 Amazon Health 中获取最新信息。

当您向全局端点发出请求时,必须指定您对目标区域端点的 Amazon 访问凭证,并为您的区域配置签名。否则,您的身份验证可能会失败。有关更多信息,请参阅 签署 Amazon Health API 请求

下表列出了默认配置。

描述 签名区域 端点 协议
Active

cn-northwest-1

health.cn-northwest-1.amazonaws.com.cn

HTTPS
Passive

cn-north-1

health.cn-north-1.amazonaws.com.cn

HTTPS
Global

cn-northwest-1

注意

这是当前主动端点的签名区域。

global.health.amaws.com.cn

HTTPS

要确定端点是否为主动端点,请在全局端点 CNAME 上进行 DNS 查找,然后从解析的名称中提取 Amazon 区域。

例 : 在全局端点上查找 DNS

以下命令在 global.health.amazonaws.com.cn 端点上完成 DNS 查找。然后,该命令返回 cn-northwest-1 区域端点。此输出告诉您应该使用哪个 Amazon Health 端点。

dig global.health.amazonaws.com.cn | grep CNAME global.health.amazonaws.com.cn. 10 IN CNAME health.cn-northwest-1.amazonaws.com.cn
提示

主动端点和被动端点都返回 Amazon Health 数据。但是,最新 Amazon Health 数据只能从主动端点获得。来自被动端点的数据最终将与主动端点保持一致。我们建议您在主动端点发生变化时重新启动所有工作流程。

使用高可用性端点演示

在以下代码示例中,Amazon Health 使用针对全局端点的 DNS 查找来确定主动区域端点和签名区域。然后,如果主动端点发生变化,代码将重新启动工作流程。

使用 Java 演示

先决条件

您必须安装 Gradle

要使用 Java 示例
  1. 从 GitHub 下载 Amazon Health 高可用性端点演示

  2. 导航到演示项目 high-availability-endpoint/java 目录。

  3. 在命令行窗口中,输入以下命令。

    gradle build
  4. 输入以下命令,以指定您的 Amazon 凭证。

    export AWS_ACCESS_KEY_ID="AKIAIOSFODNN7EXAMPLE" export AWS_SECRET_ACCESS_KEY="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" export AWS_SESSION_TOKEN="your-aws-token"
  5. 输入以下命令,以运行演示。

    gradle run
    例 : Amazon Health 事件输出

    该代码示例返回您 Amazon 账户中最近七天内的最新 Amazon Health 事件。在以下示例中,输出包括 Amazon Config 服务的 Amazon Health 事件。

    > Task :run [main] INFO aws.health.high.availability.endpoint.demo.HighAvailabilityV2Workflow - EventDetails(Event=Event(Arn=arn:aws:health:global::event/CONFIG/AWS_CONFIG_OPERATIONAL_NOTIFICATION/AWS_CONFIG_OPERATIONAL_NOTIFICATION_88a43e8a-e419-4ca7-9baa-56bcde4dba3, Service=CONFIG, EventTypeCode=AWS_CONFIG_OPERATIONAL_NOTIFICATION, EventTypeCategory=accountNotification, Region=global, StartTime=2020-09-11T02:55:49.899Z, LastUpdatedTime=2020-09-11T03:46:31.764Z, StatusCode=open, EventScopeCode=ACCOUNT_SPECIFIC), EventDescription=EventDescription(LatestDescription=As part of our ongoing efforts to optimize costs associated with recording changes related to certain ephemeral workloads, Amazon Config is scheduled to release an update to relationships modeled within ConfigurationItems (CI) for 7 EC2 resource types on August 1, 2021. Examples of ephemeral workloads include changes to Amazon Elastic Compute Cloud (Amazon EC2) Spot Instances, Amazon Elastic MapReduce jobs, and Amazon EC2 Autoscaling. This update will optimize CI models for EC2 Instance, SecurityGroup, Network Interface, Subnet, VPC, VPN Gateway, and Customer Gateway resource types to record direct relationships and deprecate indirect relationships. A direct relationship is defined as a one-way relationship (A->B) between a resource (A) and another resource (B), and is typically derived from the Describe API response of resource (A). An indirect relationship, on the other hand, is a relationship that Amazon Config infers (B->A), in order to create a bidirectional relationship. For example, EC2 instance -> Security Group is a direct relationship, since security groups are returned as part of the describe API response for an EC2 instance. But Security Group -> EC2 instance is an indirect relationship, since EC2 instances are not returned when describing an EC2 Security group. Until now, Amazon Config has recorded both direct and indirect relationships. With the launch of Advanced queries in March 2019, indirect relationships can easily be answered by running Structured Query Language (SQL) queries such as: SELECT resourceId, resourceType WHERE resourceType ='AWS::EC2::Instance' AND relationships.resourceId = 'sg-234213' By deprecating indirect relationships, we can optimize the information contained within a Configuration Item while reducing Amazon Config costs related to relationship changes. This is especially useful in case of ephemeral workloads where there is a high volume of configuration changes for EC2 resource types. Which resource relationships are being removed? Resource Type: Related Resource Type 1 AWS::EC2::CustomerGateway: AWS::VPN::Connection 2 AWS::EC2::Instance: AWS::EC2::EIP, AWS::EC2::RouteTable 3 AWS::EC2::NetworkInterface: AWS::EC2::EIP, AWS::EC2::RouteTable 4 AWS::EC2::SecurityGroup: AWS::EC2::Instance, AWS::EC2::NetworkInterface 5 AWS::EC2::Subnet: AWS::EC2::Instance, AWS::EC2::NetworkACL, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable 6 AWS::EC2::VPC: AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkACL, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::Subnet, AWS::EC2::VPNGateway, AWS::EC2::SecurityGroup 7 AWS::EC2::VPNGateway: AWS::EC2::RouteTable, AWS::EC2::VPNConnection Alternate mechanism to retrieve this relationship information: The SelectResourceConfig API accepts a SQL SELECT command, performs the corresponding search, and returns resource configurations matching the properties. You can use this API to retrieve the same relationship information. For example, to retrieve the list of all EC2 Instances related to a particular VPC vpc-1234abc, you can use the following query: SELECT resourceId, resourceType WHERE resourceType ='AWS::EC2::Instance' AND relationships.resourceId = 'vpc-1234abc' If you have any questions regarding this deprecation plan, please contact Amazon Web Services Support [1]. Additional sample queries to retrieve the relationship information for the resources listed above is provided in [2]. [1] https://aws.amazon.com/support [2] https://docs.aws.amazon.com/config/latest/developerguide/examplerelationshipqueries.html), EventMetadata={})

Java 资源

  • 有关更多信息,请参阅 Amazon SDK for Java API 参考中的 Interface HealthClient源代码

  • 有关此演示中用于 DNS 查找的库的更多信息,请参阅 GitHub 中的 dnsjava

使用 Python 演示

先决条件

您必须安装 Python 3

要使用 Python 示例
  1. 从 GitHub 下载 Amazon Health 高可用性端点演示

  2. 导航到演示项目 high-availability-endpoint/python 目录。

  3. 在命令行窗口中,输入以下命令。

    pip3 install virtualenv virtualenv -p python3 v-aws-health-env
    注意

    对于 Python 3.3 及更高版本,您可以使用内置 venv 模块来创建虚拟环境,而无需安装 virtualenv。有关更多信息,请参阅 Python 网站上的 venv - 创建虚拟环境

    python3 -m venv v-aws-health-env
  4. 输入以下命令,以激活虚拟环境。

    source v-aws-health-env/bin/activate
  5. 运行以下命令,以安装依赖项。

    pip install -r requirements.txt
  6. 输入以下命令,以指定您的 Amazon 凭证。

    export AWS_ACCESS_KEY_ID="AKIAIOSFODNN7EXAMPLE" export AWS_SECRET_ACCESS_KEY="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" export AWS_SESSION_TOKEN="your-aws-token"
  7. 输入以下命令,以运行演示。

    python3 main.py
    例 : Amazon Health 事件输出

    该代码示例返回您 Amazon 账户中最近七天内的最新 Amazon Health 事件。以下输出返回 Amazon 安全通知的 Amazon Health 事件。

    INFO:botocore.credentials:Found credentials in environment variables.
    INFO:root:Details: {'arn': 'arn:aws:health:global::event/SECURITY/AWS_SECURITY_NOTIFICATION/AWS_SECURITY_NOTIFICATION_0e35e47e-2247-47c4-a9a5-876544042721', 
    'service': 'SECURITY', 'eventTypeCode': 'AWS_SECURITY_NOTIFICATION', 'eventTypeCategory': 'accountNotification', 'region': 'global', 'startTime': datetime.datetime(2020, 8, 19, 23, 30, 42, 476000, 
    tzinfo=tzlocal()), 'lastUpdatedTime': datetime.datetime(2020, 8, 20, 20, 44, 9, 547000, tzinfo=tzlocal()), 'statusCode': 'open', 'eventScopeCode': 'PUBLIC'}, description: 
    {'latestDescription': 'This is the second notice regarding TLS requirements on FIPS endpoints.\n\nWe
    are in the process of updating all Amazon Federal Information Processing Standard (FIPS) endpoints across all Amazon regions 
    to Transport Layer Security (TLS) version 1.2 by March 31, 2021 . In order to avoid an interruption in service, we encourage you to act now, by ensuring that you connect to Amazon FIPS endpoints at a TLS version of 1.2. 
    If your client applications fail to support TLS 1.2 it will result in connection failures when TLS versions below 1.2 are no longer supported.\n\nBetween now and March 31, 2021 Amazon will remove TLS 1.0 and TLS 1.1 support from each FIPS endpoint where no connections below TLS 1.2 are detected over a 30-day period. 
    After March 31, 2021 we may deploy this change to all Amazon FIPS endpoints, even if there continue
    to be customer connections detected at TLS versions below 1.2. \n\nWe will provide additional updates and reminders on the Amazon Security Blog, with a ‘TLS’ tag [1]. If you need further guidance or assistance, please contact Amazon Web Services Support [2] or your Technical Account Manager (TAM). 
    Additional information is below.\n\nHow can I identify clients that are connecting with TLS
    1.0/1.1?\nFor customers using S3 [3], Cloudfront [4] or Application Load Balancer [5] you can use
    your access logs to view the TLS connection information for these services, and identify client
    connections that are not at TLS 1.2. If you are using the Amazon Developer Tools on your clients, 
    you can find information on how to properly configure your client’s TLS versions by visiting Tools to Build on Amazon [7] or our associated Amazon Security Blog has a link for each unique code language [7].\n\nWhat is Transport Layer Security (TLS)?\nTransport Layer Security (TLS Protocols) are cryptographic protocols designed to provide secure communication across a computer network 
    [6].\n\nWhat are Amazon FIPS endpoints? \nAll Amazon services offer Transport Layer Security (TLS) 1.2 encrypted endpoints that can be used for all API calls. Some Amazon services also offer FIPS 140-2 endpoints [9] for customers that require use of FIPS validated cryptographic libraries. \n\n[1] https://aws.amazon.com/blogs/security/tag/tls/\n[2] https://aws.amazon.com/support\n[3] 
    https://docs.aws.amazon.com/AmazonS3/latest/dev/LogFormat.html\n[4] https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html\n[5] https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-access-logs.html\n[6] https://aws.amazon.com/tools\n[7] https://aws.amazon.com/blogs/security/tls-1-2-to-become-the-minimum-for-all-aws-fips-endpoints\n[8] 
    https://en.wikipedia.org/wiki/Transport_Layer_Security\n[9] https://aws.amazon.com/compliance/fips'}
  8. 您完成后,请输入以下命令来停用虚拟机。

    deactivate

Python 资源

签署 Amazon Health API 请求

当您使用 Amazon SDK 或 Amazon Command Line Interface (Amazon CLI) 来向 Amazon 发出请求时,这些工具会自动使用您在配置工具时指定的访问密钥为您签署请求。例如,如果您使用前面用于高可用性端点演示的 Amazon SDK for Java,则无需亲自签署这些请求。

Java 代码示例

有关如何将 Amazon Health API 与 Amazon SDK for Java 一起使用的更多示例,请参阅此示例代码

当您进行请求时,我们强烈建议您不要使用 Amazon 根账户凭证定期访问 Amazon Health。您可以使用 IAM 用户的凭证。有关更多信息,请参阅 IAM 用户指南中的隐藏您的 Amazon 账户根用户访问密钥

如果您不使用 Amazon SDK 或 Amazon CLI,则必须自行对请求签名。我们建议您使用 Amazon Signature 版本 4。有关更多信息,请参阅 Amazon Web Services 一般参考 中的签署 Amazon API 请求