You need to enable JavaScript to run this app.
导航
服务端 OpenAPI
最近更新时间:2024.09.13 11:09:42首次发布时间:2023.01.04 19:24:52

本文记录火山引擎云游戏服务端 OpenAPI 功能变更和相关文档的动态。

说明

OpenAPI 文档对白名单用户开放,如有需要请联系技术支持。

2024 年 9 月
接口名称
变更说明
CreateFrameworkApp(端游)新增接口:在云游戏平台上新增伴随程序。
UpdateFrameworkApp(端游)新增接口:通过指定伴随程序 ID,更新已创建伴随程序的名称和启动时机。
DeleteFrameworkApp(端游)新增接口:删除指定伴随程序。
ManageGameFrameworkApp(端游)新增接口:伴随程序上架完成后,需要将其与目标业务下的游戏 ID 相绑定。调用本接口为指定游戏配置伴随程序。
ListFrameworkApp(端游)新增接口:查询当前账号下已创建的伴随程序信息。
ListGameFrameworkApp(端游)新增接口:查询指定游戏已配置的伴随程序。
CreateGame(端游)接口变更:预付费套餐类型新增入门型(PCX86_Entry),适用于超小型游戏。
GetProductCapacity
GetGameCapacity
PreAllocateResource
CreateDeployStrategy
GetDailyMaxQueueLength
2024 年 6 月
接口名称
变更说明
ListGameReservedID(端游)新增接口:返回指定游戏 ID 下有效的资源预锁定 ID 列表
2024 年 5 月
接口名称
变更说明
GameRestart(端游)新增接口:重启云端游戏进程
BatchStopGame新增接口:批量停止指定 ReservedId 的云游戏服务
2024 年 1 月
接口名称
变更说明
Preupload(端游)新增接口:上传游戏文件到火山引擎对象存储 TOS 前,获取上传游戏文件所需的必要信息
CreateGame(端游)新增接口:在指定业务下注册游戏
CheckGame(端游)新增接口:检查游戏包名称或游戏版本号的唯一性
CreateGameVersion(端游)新增接口:创建游戏版本,全量更新或增量更新游戏
ListGame(端游)接口变更:在返回参数中,增加”游戏包 ID“字段(game_package_id)、”游戏包版本 ID“字段(game_version_id)、”升级中游戏包版本 ID“字段(gray_game_version_id
2023 年 11 月
接口名称
变更说明
ExitUserQueue(手游)在请求参数中,新增(DeviceId)可选参数,支持用户指定设备退出游戏排队
ExitUserQueue(端游)新增接口:用户主动退出游戏排队
GetDailyMaxQueueLength(端游)新增接口:在游戏排队场景下,查询指定业务某个资源套餐前一日的最大队列长度
2023 年 10 月
接口名称
变更说明
CreateProduct(手游)在当前账号下,创建云游戏业务
DeleteProduct(手游)删除已创建的云游戏业务
CreatePrePaidOrder(手游)订购预付费实例资源
CreatePostPaidOrder(手游)订购后付费实例资源
CreateProduct(端游)在当前账号下,创建云游戏业务
DeleteProduct(端游)删除已创建的云游戏业务
CreatePrePaidOrder(端游)订购预付费实例资源
CreatePostPaidOrder(端游)订购后付费实例资源
UpdateAppliedResource(端游)修改已订购后付费资源套餐的实例数量
2023 年 8 月
接口名称
变更说明
GetCgUsedNum查询指定时间内业务维度或游戏维度累计使用资源总量
2023 年 7 月
接口名称
变更说明
GamePreStart启动云端游戏服务,但不进行推流
GetGameSessionStatus查询云端游戏服务状态
2023 年 6 月
接口名称
变更说明
DetailParseTask在返回结果中,增加“上传文件类型”字段(file_type)和“游戏数据包信息”(data_package)相关说明
CreateGame在“游戏版本信息”(game_version)请求体中,增加“上传文件类型”(file_type)、“obb数据包解压路径”(data_storage)、“游戏数据包信息”(data_package)可选参数
2023 年 5 月
接口名称
变更说明
CaptureScreen对当前云端游戏发起截图请求(异步任务)。
2023 年 4 月
接口名称
变更说明
CancelFrameworkAppVersion(新增接口)取消版本程序版本发布
ListGame在返回结果中,增加“默认伴随程序列表”字段(inner_fw_id_list
ListFrameworkApp在返回结果中,增加“伴随程序当前版本ID”字段(current_version
ListGameFrameworkApp在返回结果中,增加“伴随程序的上传来源”字段(fw_source),标识伴随程序是由客户上传或默认上传
2023 年 3 月

可订购的实例资源套餐 ID(configuration_code 参数)增加 ARMSoC_Standard(基础型)。

2022 年 8 月

本次发布包含以下新增接口:

接口名称
接口功能
HotUpdateGame对指定游戏进行热更操作。
HotUpdateGameStatus查询游戏热更任务执行的结果。

本次发布包含以下接口变更:

接口名称
接口功能
ListGame在返回结果中,增加游戏默认键位映射配置字段(default_key_mapping_list
DetailGame在返回结果中,增加游戏默认键位映射配置字段(default_key_mapping_list
CreateDeployStrategy在请求参数中增加通过指定部署策略列表(strategy_list),支持按优先级为游戏配置多个实例套餐资源(通过 configuration_code 参数配置一个实例套餐资源的功能将被逐步废弃)
UpdateDeployStrategy在请求参数中增加通过指定部署策略列表(strategy_list),支持按优先级为游戏配置多个实例套餐资源(通过 configuration_code 参数配置一个实例套餐资源的功能将被逐步废弃)
ListDeployStrategy更新返回结果说明和返回示例
PreAllocateResource在返回结果中,增加预锁定的实例资源套餐 ID 字段(configuration_code
2022 年 7 月

本次发布包含以下新增功能和变更:

2022 年 6 月

本次发布包含以下新增功能和变更:

  • “预锁定实例资源” 接口新增支持指定参数 device_id(客户端用户设备 ID)。详细信息,参考 PreAllocateResource
  • “查询游戏视频流清晰度档位” 接口(ListVideoStreamProfileId)即将下线。可参考客户端 SDK 接口说明中的 清晰度档位说明 获取清晰度档位 ID 列表和详细说明。
  • “预锁定实例资源” 接口新增支持指定参数 client_user_id(自定义客户端用户 ID)。详细信息,参考 PreAllocateResource
2022 年 4 月

本次发布包含以下新增功能和变更:

  • 新增 “更新游戏信息” 接口,详细信息,参考 UpdateGame
  • 新增 “清除部署策略” 接口。详细信息,参考 ClearDeployStrategy
  • 更新注册游戏时支持的游戏包文件最大值。详细信息,参考 CreateGame
  • 新增 “预锁定实例资源” 接口。详细信息,参考 PreAllocateResource
  • 新增 “用户自定义游戏 ID” 参数(custom_game_id)。在调用以下接口时,可选择指定 game_idcustom_game_id 进行相关操作:
    • CreateGame
    • DeleteGame
    • DetailGame
    • ListGame
    • CreateGameVersion
    • ListGameVersion
    • CreateDeployStrategy
    • UpdateDeployStrategy
    • ListDeployStrategy
    • PreAllocateResource
    • GameStop
    • ListGameSession
2022 年 3 月

发布第一版 OpenAPI 文档。