本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
在 API Gateway 中設定 REST API 的 CloudWatch 記錄功能
為了協助偵錯 API 請求執行或用戶端存取相關問題,您可以啟用 Amazon CloudWatch Logs 來記錄 API 呼叫。如需 CloudWatch 的詳細資訊,請參閱 使用 Amazon CloudWatch 指標監控 REST API 執行。
CloudWatch 中有兩種類型的 API 記錄:
-
執行記錄 – API Gateway 會記錄處理 API 請求所採取的動作,包括錯誤和執行追蹤。您也可以設定 Amazon CloudWatch Logs 交付,將執行日誌路由到您自己的目的地。
-
存取記錄 – 您記錄存取 API 的人員及其方式。您可以建立自己的日誌群組、選擇日誌格式,並指定要包含的
$context變數。
您可以個別啟用執行記錄和存取記錄。
CloudWatch 記錄的許可
若要啟用 CloudWatch Logs,您必須授予 API Gateway 為您的帳戶將日誌讀取和寫入 CloudWatch 的許可。AmazonAPIGatewayPushToCloudWatchLogs 受管政策具有所有必要的許可。
注意
API Gateway 呼叫 AWS Security Token Service 以擔任 IAM 角色,因此請務必為 區域啟用 AWS STS 。如需詳細資訊,請參閱在 AWS 區域中管理 AWS STS。
若要將這些許可授予您的帳戶,請建立 apigateway.amazonaws.com 作為其信任實體的 IAM 角色,並將先前的政策連接至 IAM 角色,然後在帳戶的 cloudWatchRoleArn 屬性上設定 IAM 角色 ARN。您必須為要啟用 CloudWatch Logs 的每個區域分別設定 cloudWatchRoleArn 屬性。 AWS CloudWatch
如果您在設定 IAM 角色 ARN 時收到錯誤,請檢查您的 AWS Security Token Service 帳戶設定,以確保 AWS STS 在您所使用的區域中已啟用 。如需啟用 的詳細資訊 AWS STS,請參閱《IAM 使用者指南》中的在 AWS 區域中管理 AWS STS。