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

# 稽核記錄

> 保留 CLI 所執行之 PlayFab 作業的選擇性加入、本機且僅含中繼資料的記錄。

XBOX CLI 可以在本機記錄它執行了哪些 PlayFab 作業、針對哪個遊戲，以及執行時間。您可以使用它事後查看您 (或代表您執行 CLI 的代理程式) 做了什麼。此記錄預設為關閉，只會保留在您的電腦上，且不包含要求本文、回應、權杖或身分識別。

此記錄只會記錄 PlayFab 呼叫。使用 Partner Center 和 XBOX services 的命令 (例如 `xbox xbl` 和 `xbox game`) 不會被記錄。

## 開啟稽核記錄

將 `XBOX_AUDITLOG__ENABLED` 設定為 `true`。在 bash 或 zsh 中：

```bash theme={null}
export XBOX_AUDITLOG__ENABLED=true
```

在 PowerShell 中：

```powershell theme={null}
$env:XBOX_AUDITLOG__ENABLED = "true"
```

## 記錄的存放位置

CLI 每天寫入一個檔案，並保留最近 31 個檔案：

| 平台 | 路徑 |
| - | - |
| Windows | `%LOCALAPPDATA%\XboxDevCLI\audit<date>.jsonl` |
| Linux | `$XDG_DATA_HOME/XboxDevCLI/audit<date>.jsonl`，預設為 `~/.local/share` |
| macOS | `~/Library/Application Support/XboxDevCLI/audit<date>.jsonl` |

這些檔案沒有大小限制，因此如果您每天進行許多 API 呼叫，請留意磁碟空間。

## 記錄的內容

每個 PlayFab 呼叫都會新增一行[精簡 JSON](https://clef-json.org/)，無論該呼叫是讀取還是變更內容：

```json theme={null}
{"@t":"2026-08-25T16:59:47.3966336Z","@mt":"PlayFab invocation {ResolvedApiPath} {TitleId} {ExitStatus}","ResolvedApiPath":"/Admin/GetTitleData","TitleId":"ABC123","ExitStatus":0}
```

| 欄位 | 意義 |
| - | - |
| `@t` | 呼叫的 UTC 時間 |
| `ResolvedApiPath` | PlayFab API 路徑，不含查詢字串 |
| `TitleId` | 呼叫所針對的 PlayFab 遊戲；若為 Studio API (`/Studio/*`) 則為 `null` |
| `ExitStatus` | 呼叫成功時為 `0`，失敗時為 `1` |

您在確認提示中拒絕的破壞性作業不會被記錄，因為它從未呼叫 PlayFab。

## 無法寫入記錄時

命令仍會執行並傳回相同的結果，而 CLI 會在 stderr 上列印警告，讓您知道記錄有所缺漏。

## 稽核記錄與遙測

稽核記錄不屬於[遙測](https://docs.xbox.com/zh-TW/tools/xbox-cli/telemetry.md)的一部分：

| | 遙測 | 稽核記錄 |
| - | - | - |
| 目的地 | Microsoft | 僅限您的電腦 |
| PlayFab 遊戲 ID | 絕不記錄 | 會記錄 |
| 預設值 | 開啟；可選擇退出 | 關閉；需選擇加入 |


## Related topics

- [稽核記錄](https://docs.xbox.com/zh-TW/services/playfab/live-service-management/gamemanager/audit-logs.md)
- [PlayFab 2015 年版本資訊](https://docs.xbox.com/zh-TW/announcements/playfab/2015.md)
- [XBOX CLI](https://docs.xbox.com/zh-TW/tools/xbox-cli/index.md)
- [PlayFab 即時服務管理文件](https://docs.xbox.com/zh-TW/services/playfab/live-service-management/index.md)
- [組態](https://docs.xbox.com/zh-TW/tools/xbox-cli/configuration.md)
