跳转到主要内容
playfab api 通过路径调用任何 PlayFab API 终结点,发送你传递的请求正文,并以 JSON 形式写入 PlayFab 的响应。若要查找操作及其请求正文,请参阅 查找 API。
该命令需要 PlayFab 游戏,但工作室 API (/Studio/*) 除外,因为它们不限定于某个游戏。请参阅上下文。 该命令更改的内容取决于路径。名称以 Get、 List 或 Search 开头的操作只执行读取。Delete* 和 Shutdown* 操作在终端中会先询问,在其他环境中则需要 --confirm (--yes, -y)。请参阅 安全性和破坏性操作。

参数和选项

--body 和 --body-file 不能结合使用。CLI 会按你传递的原样发送正文,而不对其进行验证。

示例

从 stdin 读取请求正文

stdin 提供一个请求正文,读取到输入结束为止,而不是每行一个请求。 使用 --body-file - 时,即使在终端中,Delete* 和 Shutdown* 操作也需要 --confirm,因为 stdin 无法响应提示。

在 Windows 上从 Git Bash 运行

与其他 MSYS shell 一样,Git Bash 在启动 Windows 程序之前,会将以 / 开头的参数转换为 Windows 路径。CLI 会拒绝转换后的路径,并说明如何修复:
为单个命令设置 MSYS_NO_PATHCONV=1:
或者为会话的其余部分导出它:
关闭转换后,Git Bash 也不会转换其他路径,因此请向 --body-file 传递相对路径或 Windows 路径(例如 C:/requests/search.json),而不是 /c/requests/search.json。

输出

PlayFab 的响应,位于其 {code,status,data} 信封中;请参阅 响应信封。当调用失败时,该命令会将错误写入 stderr 并以代码 1 退出;请参阅 错误响应。 playfab api 不接受 --output table。
最后修改于 2026年11月19日