Como integrar o AWS Health com outros sistemas usando a API do AWS Health
O AWS Health é um serviço web RESTful que usa HTTPS como um transporte e JSON (JavaScript Object Notation) como um formato de serialização de mensagens. O código de seu aplicativo pode fazer solicitações diretamente à API do AWS Health. Quando usar a API REST diretamente, você deverá gravar o código necessário para assinar e autenticar suas solicitações. Para mais informações sobre as operações e parâmetros do AWS Health consulte AWS HealthReferências de API do .
nota
É necessário ter um plano de suporte Business, Enterprise On-Ramp ou Enterprise da AWS SupportSubscriptionRequiredException.
Você pode usar o SDKs de AWS que encapsulam as chamadas da AWS Health API REST, que simplificam o seu desenvolvimento de aplicativos. Você fornece suas credenciais AWS, e essas bibliotecas cuidam da autenticação e da assinatura das solicitações.
AWS Health também oferece um AWS Health Dashboard no AWS Management Console que você pode usar para exibir e pesquisar eventos e entidades afetadas. Consulte Conceitos básicos do painel do AWS Health.
Tópicos
Assinar solicitações de API do AWS Health
Quando você usa as AWS SDKs ou a AWS Command Line Interface (AWS CLI) para fazer solicitações para AWS, essas ferramentas assinam automaticamente as solicitações para você com a chave de acesso que você especifica ao configurar as ferramentas. Por exemplo, se você usar o AWS SDK for Java para a demonstração anterior do endpoint de alta disponibilidade, não precisará assinar solicitações por si mesmo.
Exemplos de código Java
Para ver mais exemplos de como usar a API AWS Health com o AWS SDK for Java, consulte este código de exemplo.
Ao fazer as suas solicitações, é altamente recomendável que você não use as credenciais da sua conta raiz AWS para o acesso regular ao AWS Health. Você pode usar as credenciais de um usuário do IAM. Para obter mais informações, consulte Bloquear suas chaves de acesso (raiz) da conta da AWS no Manual do usuário do IAM.
Se você não usar os AWS SDKs ou o AWS CLI, então precisará cadastrar as suas solicitações você mesmo. Recomendamos usar a AWS Versão 4 da assinatura. Para obter mais informações, consulte Assinatura de solicitações da API AWS da no Referência geral da AWS.
Como escolher endpoints para solicitações de API do AWS Health
A API do AWS Health segue uma Multi-Region Application Architecture e tem dois endpoints regionais em uma configuração do tipo ativo-passivo. Para oferecer compatibilidade com o failover de DNS ativo-passivo, AWS Health fornece um endpoint único e global. Você pode realizar uma pesquisa de DNS no endpoint global para determinar o endpoint ativo e a região de assinatura correspondente AWS. Isso ajuda você a saber qual endpoint usar em seu código, para que você possa obter as informações mais recentes AWS Health.
Ao fazer uma solicitação ao endpoint global, você deve especificar suas credenciais de acesso de AWS ao endpoint regional de destino e configurar a assinatura para sua região. Caso contrário, sua autenticação poderá falhar. Para ter mais informações, consulte Assinar solicitações de API do AWS Health.
A tabela a seguir representa a configuração padrão.
| Descrição | Região de assinatura | Endpoint | Protocolo |
|---|---|---|---|
| Ativo |
us-east-1 |
health.us-east-1.amazonaws.com |
HTTPS |
| Passivo |
us-east-2 |
health.us-east-2.amazonaws.com |
HTTPS |
| Global |
us-east-1 notaEssa é a região de assinatura do endpoint ativo atual. |
global.health.amazonaws.com |
HTTPS |
Para determinar se um endpoint é o endpoint ativo, faça uma pesquisa de DNS no CNAME do endpoint global e, em seguida, extraia a região AWS do nome resolvido.
exemplo : pesquisa de DNS no endpoint global
. Em seguida, o comando retorna o endpoint Região us-east-1. Essa saída informa para qual endpoint você deve usar AWS Health.
dig global.health.amazonaws.com | grep CNAMEglobal.health.amazonaws.com. 10 IN CNAME health.us-east-1.amazonaws.com
dica
Tanto os endpoints ativos quanto os passivos retornam dados AWS Health. No entanto, os dados AWS Health mais recentes só estão disponíveis no endpoint ativo. Os dados do endpoint passivo acabarão sendo consistentes com o endpoint ativo. Recomendamos que você reinicie todos os fluxos de trabalho quando o endpoint ativo for alterado.
