Amazon API Gateway 維度和指標 - Amazon API Gateway

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

Amazon API Gateway 維度和指標

API Gateway 傳送給 Amazon 的指標和維度 CloudWatch 如下所示。如需詳細資訊,請參閱 使用 Amazon CloudWatch 指標監控RESTAPI執行

API Gateway 指標

Amazon API Gateway 會將指標資料傳送到 CloudWatch 每分鐘一次。

AWS/ApiGateway 命名空間包含下列指標。

指標 描述

4XXError

在指定期間內擷取的用戶端錯誤數目。

API Gateway 會將修改後的閘道回應狀態碼計為 4xxError 錯誤。

Sum 統計資訊代表此指標,即指定期間內的 4XXError 錯誤總數。Average 統計資訊代表 4XXError 錯誤率,即期間內的 4XXError 錯誤總數除以要求總數。分母對應至 Count 指標 (下方)。

Unit: Count

5XXError

在指定期間內擷取的伺服器端錯誤數目。

Sum 統計資訊代表此指標,即指定期間內的 5XXError 錯誤總數。Average 統計資訊代表 5XXError 錯誤率,即期間內的 5XXError 錯誤總數除以要求總數。分母對應至 Count 指標 (下方)。

Unit: Count

CacheHitCount

在指定期間內從 API 快取提供的要求數目。

Sum 統計資訊代表此指標,即指定期間內的快取命中總數。Average 統計資訊代表快取命中率,即期間內的快取命中總數除以要求總數。分母對應至 Count 指標 (下方)。

Unit: Count

CacheMissCount

啟用 API 快取時,在指定期間內從後端提供的要求數目。

Sum 統計資訊代表此指標,即指定期間內的快取未命中總數。Average 統計資訊代表快取未命中率,即期間內的快取未命中總數除以要求總數。分母對應至 Count 指標 (下方)。

Unit: Count

Count

指定期間內的 API 要求總數。

SampleCount 統計資訊代表此指標。

Unit: Count

IntegrationLatency

API Gateway 將請求轉送給後端時與收到來自後端的回應時之間的時間。

Unit: Millisecond

Latency

API Gateway 收到來自用戶端的請求時與它將回應傳回給用戶端時之間的時間。延遲包含整合延遲與其他 API Gateway 額外負荷。

Unit: Millisecond

指標的維度

您可以使用下表中的維度來篩選 API Gateway 指標。

注意

API Gateway 會先從維度中移除非 ASCII 字元,然後再將量ApiName度傳送至 CloudWatch。如果 APIName 不含 ASCII 字元,API ID 則會做為 ApiName 使用。

維度 描述

ApiName

篩選所指定 API 名稱之 REST API 的 API Gateway 指標。

ApiName, Method, Resource, Stage

篩選所指定 API 名稱、階段、資源與方法之 API 方法的 API Gateway 指標。

除非您已明確啟用詳細指標,否則 API Gateway 不會傳送這些 CloudWatch 指標。在主控台中選擇某個階段,然後針對日誌和追蹤選取編輯。選取詳細指標,然後選擇儲存變更。或者,您可以呼叫更新階段 AWS CLI 命令,將metricsEnabled屬性更新為。true

啟用這些指標會產生您帳戶的額外費用。如需定價資訊,請參閱 Amazon CloudWatch 定價

ApiName, Stage

篩選所指定 API 名稱和階段之 API 階段資源的 API Gateway 指標。