根据任务 ID(task_id
),查询游戏热更任务执行的结果。
使用 GET 方式发起请求。
下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考 公共请求参数。
字段 | 位置 | 类型 | 必填 | 说明 | 值 |
---|---|---|---|---|---|
Action | Query | String | 是 | 公共参数,OpenAPI 接口名称 | HotUpdateGameStatus |
Version | Query | String | 是 | 公共参数,OpenAPI 接口版本 | 2022-02-10 |
task_id | Query | String | 是 | 任务 ID | 例:7128301917603xxxxxx |
通用返回参数,参考 ResponseMetadata 结构说明。
Result 字段包含以下参数:
字段 | 类型 | 说明 |
---|---|---|
task_status | Int8 | 任务状态:
|
files_status | List<file_status> | 热更资源文件状态信息,参考以下 文件状态信息结构说明 |
文件状态信息结构说明
字段 | 类型 | 说明 |
---|---|---|
download_url | String | 热更资源下载链接 |
is_started | Boolean | 是否已开始往边缘机房推送资源 |
process | List<process> | 详细的进度信息,参考以下 进度信息结构说明 |
进度信息结构说明
字段 | 类型 | 说明 |
---|---|---|
total | Int64 | 该游戏资源的任务总数 |
active | Int64 | 该游戏资源的任务正在执行数量 |
succeeded | Int64 | 该游戏资源的任务成功数量 |
failed | Int64 | 该游戏资源的任务失败数量(任务失败时,系统会进行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 } } ] } }