> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# api_rate_limit_alert

> API 呼叫端接近或達到速率限制時引發的預覽版 PlayFab 事件，包含 API、呼叫端實體和限制超越情形等屬性。

> \[!NOTE]
> 此事件為預覽版。其承載、行為和可用性可能會變更。

當 API 呼叫端接近或達到速率限制時，可能會觸發此事件。目前會在達到限制的 80% 時發出警告，但此閾值與此事件的其他細節一樣，可能會變更。在追蹤期間內，使用量第一次超過警告閾值 (`Warning`) 或限制本身 (`HardLimit`) 時會發出警示，而不是在之後的每次呼叫都發出。若要判斷呼叫是否遭到節流，請使用 HTTP 429 回應。您可以在 Game Manager 的 **Data Explorer** 中查詢此事件。如需速率限制的詳細資訊，請參閱 [PlayFab 中的節流](/zh-TW/services/playfab/live-service-management/service-gateway/throttling/what-is-throttling)。

## 屬性

| 名稱 | 類型 | 描述 |
| :- | :- | :- |
| API | String | 所呼叫的 PlayFab API。例如 `client/gettime`。 |
| CallerEntityType | String | 發出呼叫之實體的類型。例如 `title_player_account` 或 `title`。 |
| CallerEntityId | String | 發出呼叫之實體的識別碼。可能會被省略或遮罩。 |
| Crossings | object\[] | 呼叫所接近或達到的速率限制。在每個項目中，接近限制時 `CrossingType` 為 `Warning`，達到限制時為 `HardLimit`，而 `LimitKind`、`TrackingPeriod` 和 `Limit` 描述該限制。針對目標實體之限制的項目也會包含 `TargetEntityType` 和 `TargetEntityId`，且該識別碼可能會被省略或遮罩。 |

## 通用屬性

所有 V2 PlayStream 事件都會格式化為 JSON 物件，且大多數共用下列通用屬性：

| 名稱 | 類型 | 描述 |
| :- | :- | :- |
| SchemaVersion | String | PlayStream 事件格式版本，遵循語意化版本控制配置。 |
| FullName | [Object](/zh-TW/services/playfab/api-references/events/data-types/fullnameobject) | 事件名稱與事件命名空間的組合，用來完整指定事件類型。 |
| Id | String | PlayFab 為此事件指派的唯一識別碼。 |
| Timestamp | DateTime | 與此事件相關聯的時間 (UTC)。 |
| Entity | [Object](/zh-TW/services/playfab/api-references/events/data-types/entityobject) | 此事件所套用之實體的詳細資料，包括實體識別碼和實體類型。 |
| Originator | [Object](/zh-TW/services/playfab/api-references/events/data-types/originatorobject) | 描述起始此事件之來源和來源類型的物件。 |
| PayloadContentType | String | 指定事件承載的內容。預設為 "JSON"。 |
| Origin Info | Object | 包含源自 PlayFab 外部之事件相關資訊的選用欄位。 |


## Related topics

- [PlayFab 的 PlayStream 事件模型參考](/zh-TW/services/playfab/api-references/events/index.md)
- [事件](/zh-TW/services/xbox-services/player-data/stats-leaderboards/event-based/events/index.md)
- [節流最佳做法](/zh-TW/services/playfab/live-service-management/service-gateway/throttling/best-practices.md)
- [title_client_rate_limited_alert](/zh-TW/services/playfab/api-references/events/Title/title-client-rate-limited-alert.md)
- [title_high_error_rate_alert](/zh-TW/services/playfab/api-references/events/Title/title-high-error-rate-alert.md)