You need to enable JavaScript to run this app.
导航
游戏热更状态
最近更新时间:2025.01.20 15:42:49首次发布时间:2022.08.18 11:19:01

根据任务 ID(task_id),查询游戏热更任务执行的结果。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称HotUpdateGameStatus
VersionQueryString公共参数,OpenAPI 接口版本2022-02-10
task_idQueryString任务 ID例:7128301917603xxxxxx

返回结果

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

Result 字段包含以下参数:

字段
类型
说明

task_status

Int8

任务状态:

  • 1:执行中
  • 2:成功
  • 3:失败
files_statusList<file_status>热更资源文件状态信息,参考以下 文件状态信息结构说明

文件状态信息结构说明

字段
类型
说明
download_urlString热更资源下载链接
is_startedBoolean是否已开始往边缘机房推送资源
processList<process>详细的进度信息,参考以下 进度信息结构说明

进度信息结构说明

字段
类型
说明
totalInt64该游戏资源的任务总数
activeInt64该游戏资源的任务正在执行数量
succeededInt64该游戏资源的任务成功数量
failedInt64该游戏资源的任务失败数量(任务失败时,系统会进行3次重试。如果重试失败,该文件资源的推送就认为整体失败。如果游戏版本有多个文件,当部分文件推送失败时,只需要对失败的文件进行重新发送)

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "Action": "HotUpdateGameStatus",
        "Region": "cn-north-1",
        "RequestId": "2022080516124901022514606305039ED3",
        "Service": "veGame",
        "Version": "2022-02-10"
    },
    "Result": {
        "task_status": 2,
        "files_status": [
            {
                "download_url": "http://file.oss.com/cloudgame/game.apk?x-expires=4816598400&x-signature=A555ElTFSzGHlZiMEo2wV9OhXXXXXX",
                "is_started": true,
                "process": {
                    "total": 8,
                    "active": 0,
                    "succeeded": 8,
                    "failed": 0
                }
            },
            {
                "download_url": "http://file.oss.com/cloudgame/user.tar.gz?x-expires=4815907200&x-signature=D%2FZgTSfuJB%2FETqflSBxuYlCOXXXXXX",
                "is_started": true,
                "process": {
                    "total": 8,
                    "active": 0,
                    "succeeded": 8,
                    "failed": 0
                }
            },
            {
                "download_url": "http://file.oss.com/cloudgame/user.tar?x-expires=2605592945&x-signature=Fa9EUo7QtOQ5QabuZzHaYmmzXXXXXX",
                "is_started": true,
                "process": {
                    "total": 8,
                    "active": 0,
                    "succeeded": 8,
                    "failed": 0
                }
            }
        ]
    }
}