游戏热更--云游戏-火山引擎

文档中心

立即注册

导航

游戏热更

最近更新时间：2025.01.20 15:42:49首次发布时间：2022.08.18 11:19:01

对指定游戏进行热更操作。

注意：
必须在游戏版本发布完成后，才可发起热更操作，否则会失败；
在某个游戏版本发布取消并回退到旧版本时，可以在旧版本上进行热更操作。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	HotUpdateGame
Version	Query	String	是	公共参数，OpenAPI 接口版本	2022-02-10

Body 参数

字段	类型	必填	说明
game_id	String	否	游戏 ID，可通过调用 ListGame 接口获取与 custom_game_id 二选一
custom_game_id	String	否	用户自定义游戏 ID，可通过调用 ListGame 接口获取与 game_id 二选一
resource_path	String	否	游戏热更资源所在路径, 可选项： app（表示资源是 `/data/app/{package_name}/` 下的文件） sdcard（表示资源是 `/data/media/0/Android/data/{package_name}/` 下的文件） data（表示资源是 `/data/data/{package_name}/` 下的文件）
relative_path	String	否	“游戏热更资源所在路径+包名下” 的相对路径，例如：如果资源所在路径为：`/data/media/0/Android/data/com.hermes.j1game/files/datas`，则资源路径 `rsource_path` 的值为 `sdcard`，相对路径 `relative_path` 的值为 `files/datas` 如果资源所在路径为：`/data/data/com.hermes.j1game/cache`，则资源路径 `resource_path` 的值为 `data`，相对路径 `relative_path` 的值为 `cache`
file_type	String	否	文件类型（tar/tgz文件会解压, 不填则不解压）
files_info	`List<file\_info>`	是	各个游戏热更资源文件的信息，参考以下资源文件结构信息

资源文件结构信息

字段	类型	必填	说明
download_url	String	是	热更资源文件下载链接（最多可支持 30 个下载链接）
file_name	String	否	热更资源文件名称（如不指定，则会获取下载链接 URL 中最后一个 '/' 符号后的内容）
resource_path	String	否	游戏热更资源所在路径, 可选项： app（表示资源是 `/data/app/{package_name}/` 下的文件） sdcard（表示资源是 `/data/media/0/Android/data/{package_name}/` 下的文件） data（表示资源是 `/data/data/{package_name}/` 下的文件）
relative_path	String	否	“游戏热更资源所在路径+包名下” 的相对路径，例如：如果资源所在路径为：`/data/media/0/Android/data/com.hermes.j1game/files/datas`，则资源路径 `rsource_path` 的值为 `sdcard`，相对路径 `relative_path` 的值为 `files/datas` 如果资源所在路径为：`/data/data/com.hermes.j1game/cache`，则资源路径 `resource_path` 的值为 `data`，相对路径 `relative_path` 的值为 `cache`
file_type	String	否	文件类型（tar/tgz文件会解压, 不填则不解压）

说明

files_info 结构中的 resource_path 和 relative_path 参数和外部同名参数至少需要指定一个；
files_info 结构中的参数优先级更高。

返回结果

通用返回参数，参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
task_id	string	本次游戏热更的任务 ID，可用于游戏热更状态接口查询游戏热更任务执行的结果

示例

请求示例

POST https://open.volcengineapi.com?Action=HotUpdateGame
&Version=2022-02-10
&<通过header传入的公共请求参数>

{
    "game_id": "7127549437509xxxxxx",
    "resource_path": "data",
    "relative_path": "cache",
    "files_info": [
        {
            "download_url": "http://file.oss.com/cloudgame/game.apk?x-expires=4816598400&x-signature=A555ElTFSzGHlZiMEo2wV9OhXXXXXX",
            "file_name": "tes1.apk",
            "resource_path": "app",
            "relative_path": "cached"
        },
        {
            "download_url": "http://file.oss.com/cloudgame/user.tar.gz?x-expires=4815907200&x-signature=D%2FZgTSfuJB%2FETqflSBxuYlCOXXXXXX",
            "resource_path": "sdcard",
            "relative_path": "testd",
            "file_type":"tgz"
        },
        {
            "download_url": "http://file.oss.com/cloudgame/user.tar?x-expires=2605592945&x-signature=Fa9EUo7QtOQ5QabuZzHaYmmzXXXXXX",
            "resource_path": "data",
            "relative_path": "file_d",
            "file_type":"tar"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "HotUpdateGame",
        "Region": "cn-north-1",
        "RequestId": "202203091616060101980160152617650B",
        "Service": "veGame",
        "Version": "2022-02-10"
    },
    "Result": {
        "task_id": "7128301917603xxxxxx"
}