使用 AWS Health 與其他系統整合 AWS Health API - AWS Health

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

使用 AWS Health 與其他系統整合 AWS Health API

AWS Health 是一種 RESTful Web 服務,使用 HTTPS做為傳輸和JSON訊息序列化格式。您的應用程式程式碼可以直接向 AWS Health 提出請求API。當您RESTAPI直接使用 時,您必須撰寫必要的程式碼來簽署和驗證您的請求。如需 AWS Health 操作和參數的詳細資訊,請參閱 AWS Health API 參考

注意

您必須擁有來自 的業務、企業功能提升或企業支援計劃AWS 支援,才能使用 AWS Health API。如果您 AWS Health API從沒有商業、企業駐場或企業支援計劃的 AWS 帳戶呼叫 ,您會收到SubscriptionRequiredException錯誤。

您可以使用 AWS SDKs來包裝 AWS Health RESTAPI呼叫,這可以簡化您的應用程式開發。您可以指定您的 AWS 登入資料,這些程式庫會為您處理身分驗證和請求簽署。

AWS Health 也在 中提供 AWS Health 儀表板 AWS Management Console ,您可以用來檢視和搜尋事件和受影響的實體。請參閱 AWS Health 儀表板入門

簽署 AWS Health API請求

當您使用 AWS SDKs或 AWS Command Line Interface (AWS CLI) 向 發出請求時 AWS,這些工具會自動使用您在設定工具時指定的存取金鑰來簽署請求。例如,如果您將 AWS SDK for Java 用於先前的高可用性端點示範,則不需要自行簽署請求。

Java 程式碼範例

如需如何搭配 AWS Health API使用 的更多範例 AWS SDK for Java,請參閱此範例程式碼

當您提出請求時,強烈建議您不要使用 AWS 根帳戶登入資料來定期存取 AWS Health。您可以使用 IAM使用者的登入資料。如需詳細資訊,請參閱《 IAM 使用者指南》中的鎖定 AWS 您的帳戶根使用者存取金鑰

如果您不使用 AWS SDKs或 AWS CLI,則必須自行簽署請求。我們建議您使用 AWS Signature 第 4 版。如需詳細資訊,請參閱 中的簽署 AWS API請求AWS 一般參考

選擇請求的 AWS Health API端點

AWS Health API 遵循多區域應用程式架構,並在主動-被動組態中有兩個區域端點。為了支援主動-被動DNS容錯移轉, AWS Health 提供單一的全域端點。您可以在全域端點上執行DNS查詢,以判斷作用中端點和對應的簽署 AWS 區域。這可協助您了解要在程式碼中使用的端點,以便從中取得最新資訊 AWS Health。

當您向 全域端點提出請求時,您必須指定您目標區域端點的 AWS 存取憑證,並為區域設定簽署。否則,您的身分驗證可能會失敗。如需詳細資訊,請參閱簽署 AWS Health API請求

下表代表預設組態。

描述 簽署區域 端點 通訊協定
作用中

us-east-1

health.us-east-1.amazonaws.com

HTTPS
被動

us-east-2

health.us-east-2.amazonaws.com

HTTPS
全球服務

us-east-1

注意

這是目前作用中端點的簽署區域。

global.health.amazonaws.com

HTTPS

若要判斷端點是否為作用中端點,請對全域端點 進行DNS查詢CNAME,然後從解析的名稱中擷取 AWS 區域。

範例 :DNS查詢全域端點

下列命令完成 global.health.amazonaws.com 端點的DNS查詢。命令接著會傳回 us-east-1 區域端點。此輸出會告訴您應該使用哪個端點 AWS Health。

dig global.health.amazonaws.com | grep CNAME global.health.amazonaws.com. 10 IN CNAME health.us-east-1.amazonaws.com
提示

主動和被動端點都會傳回 AWS Health 資料。不過,最新的 AWS Health 資料只能從作用中端點取得。來自被動端點的資料最終將與主動端點一致。我們建議您在作用中端點變更時重新啟動任何工作流程。