OpenAPI 概览--云游戏-火山引擎

文档中心

导航

OpenAPI 概览

最近更新时间：2025.10.23 15:52:30首次发布时间：2021.10.15 14:01:12

云游戏结合了云计算和超低延迟的实时流技术，通过跨终端虚拟云服务，为客户提供流畅、实时、高效的分布式云计算与边缘计算服务。
我们开放了云游戏实例资源管理、游戏管理、游戏部署配置、游戏服务管理、用户属性管理相关业务的 OpenAPI。本文档为您提供具体的 API 描述、语法、参数说明及示例等，您可以调用 API 管理云游戏服务资源。

业务管理接口

业务是用户在云游戏平台管理实例资源、游戏资源、开展云游戏业务的标识。业务管理相关接口如下：

接口名称	接口功能
CreateProduct	创建云游戏业务
GetProductList	获取云游戏业务列表
DeleteProduct	删除云游戏业务

后付费实例资源管理接口

实例资源是游戏在云端运行的基础环境。后付费实例资源管理相关接口如下：

接口名称	接口功能
CreatePostPaidOrder	订购后付费实例资源。
UpdateAppliedResource	在后付费计费模式下，修改已订购资源套餐的实例数量。

预付费实例资源管理接口

实例资源是游戏在云端运行的基础环境。预付费实例资源管理相关接口如下：

接口名称	接口功能
ListResourceSet	查询某个业务下的正在生效的资源组列表。
ListResource	查询以套餐为维度的资源列表。
CreatePrePaidOrder	订购预付费实例资源。

游戏管理接口

游戏管理包括游戏上下架、游戏列表管理等操作。游戏管理相关接口如下：

说明

建议通过火山引擎云游戏控制台进行游戏管理操作，以下 OpenAPI 接口供业务方选择使用。

接口名称	接口功能
CreateGame	在指定业务下，注册游戏。
ListGame	查询指定业务下所有游戏信息。
ListGameVersion	查询指定游戏的版本信息。
CreateParseTask	创建游戏安装包文件的解析任务（异步）。
DetailParseTask	获取游戏安装包文件解析任务的结果（异步）。
UpdateGame	更新已注册游戏的信息。
DeleteGame	在某个业务下，下架并删除指定游戏。
DetailGame	查询某个游戏的详细信息。
CreateGameVersion	为指定游戏创建新版本。
HotUpdateGame	对指定游戏进行热更操作。
HotUpdateGameStatus	查询游戏热更任务执行的结果。
ListGameSession	查询某段时间内指定游戏发生的游戏会话时长。

部署配置接口

游戏上传完成后，可以配置运行游戏的实例套餐。游戏部署配置相关接口如下：

说明

建议通过火山引擎云游戏控制台进行游戏管理操作，以下 OpenAPI 接口供业务方选择使用。

接口名称	接口功能
CreateDeployStrategy	为指定游戏配置其使用的实例套餐。
UpdateDeployStrategy	更新指定游戏的实例套餐配置。
ClearDeployStrategy	清除指定游戏的实例套餐配置。
ListDeployStrategy	查询指定游戏的实例套餐配置信息。

服务管理接口

云游戏服务管理相关接口如下：

接口名称	接口功能
PreAllocateResource	预锁定实例资源，可以用于业务排队预申请场景。
GamePreStart	启动云端游戏服务，但不进行推流。
GetGameSessionStatus	查询云端游戏服务状态。
GameStop	停止云游戏服务。
ExitUserQueue	用户退出游戏排队。
GetProductCapacity	查询当前业务已订购实例总量和已使用实例总量信息。
GetGameCapacity	查询游戏维度和用户维度的资源容量信息。
GetCgUsedNum	查询指定时间内业务维度或游戏维度累计使用资源总量。
CaptureScreen	云端游戏运行画面截图。
BatchStopGame	批量停止指定 ReservedId 的云游戏服务。
GetDailyMaxQueueLength	在游戏排队场景下，查询指定业务某个资源套餐下每日的最大队列长度。

伴随程序管理接口

伴随程序是云端游戏运行的基础或条件，伴随程序管理相关接口如下：

接口名称	接口功能
CreateFrameworkApp	在指定业务下，注册和创建伴随程序。
ListFrameworkApp	查询当前账号下的伴随程序信息。
UpdateFrameworkApp	更新已创建伴随程序的名称和启动时机。
DeleteFrameworkApp	删除指定伴随程序。
CreateFrameworkAppVersion	为指定伴随程序创建新版本。
CancelFrameworkAppVersion	取消指定伴随程序版本发布。
ListFrameworkAppVersion	查询指定伴随程序的版本信息。
ManageGameFrameworkApp	为指定游戏配置伴随程序。
ListGameFrameworkApp	查询指定游戏已配置的伴随程序。

用户属性管理接口

用户属性管理相关接口如下：

接口名称	接口功能
CreateUserTag	根据业务需求，创建用户属性。
DeleteUserTag	根据业务需求，删除用户属性。
ListUserTag	查询已创建的用户属性列表。

数据监控接口

数据监控相关接口如下：

接口名称	接口功能
GetBandwidthDetail	查询指定时间范围内账号、平台、业务、游戏维度的带宽打点明细数据。

Token 签发接口

Token 用于对接入云游戏服务的用户进行鉴权。Token 签发相关接口如下：

接口名称	接口功能
STSToken	签发临时 Token。