游戏详情查询--云游戏-火山引擎

文档中心

立即注册

导航

游戏详情查询

最近更新时间：2025.01.20 15:42:48首次发布时间：2022.03.01 17:31:35

查询某个游戏的详细信息。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	DetailGame
Version	Query	String	是	公共参数，OpenAPI 接口版本	2022-02-10
game_id	Query	String	否	筛选条件，游戏 ID	可通过调用 ListGame 接口获取当传入 custom_game_id 时，可不传入（以 game_id 优先）
custom_game_id	Query	String	否	筛选条件，用户自定义游戏 ID	可通过调用 ListGame 接口获取当传入 game_id 时，可不传入
include_version	Query	Boolean	否	是否返回游戏版本列表	true（返回） false（不返回，默认）

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
game_info	Array of object	游戏信息，参考以下 Game Info 结构说明
game_version_list	`List<GameVersion>`	游戏版本列表，参考以下 GameVersion 结构说明

Game Info 结构说明

字段	类型	说明
product_id	String	业务 ID
game_id	String	游戏 ID
custom_game_id	String	用户自定义游戏 ID
game_name	String	游戏名称
game_rotation	String	游戏的横竖屏： landscape（横屏显示） portrait（竖屏显示）
game_status	Int32	游戏上架状态： 1（上架完成） 2（首次适配中） 3（新版本适配中） 4（适配失败） 5（新版本适配取消，即取消发布游戏新版本）
current_version	String	游戏当前版本 ID
create_at	Int64	游戏创建时间
has_deploy_strategy	Boolean	是否有指定资源套餐可以启动游戏： false（初始状态，游戏无部署策略，需要指定资源套餐） true（已指定启动游戏的资源套餐，可以启动游戏）
user_profile_path_list	String[]	保存用户游戏配置文件的路径列表
game_type	String	游戏平台标识： pc android
default_key_mapping_list	String[]	默认游戏键位映射配置

GameVersion 结构说明

字段	类型	说明
game_id	String	游戏 ID
custom_game_id	String	用户自定义游戏 ID
version_id	String	游戏版本 ID
download_url	String	游戏包下载地址
package_name	String	游戏包名称
version_code	Int64	游戏版本 ID，仅作为标识
package_size	Int32	文件大小，单位KB
md5	String	游戏文件 MD5
create_time	Int64	版本创建时间
update_time	Int64	版本更新时间

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "Action": "DetailGame",
        "Region": "cn-north-1",
        "RequestId": "20220222115605010225094075005C6BEB",
        "Service": "veGame",
        "Version": "2022-02-10"
    },
    "Result": {
        "game_info": {
            "product_id": "1493136114825xxxxxx",
            "game_id": "7064461037646xxxxxx",
            "custom_game_id": "game01",
            "game_name": "游戏名",
            "game_rotation": "landscape",
            "game_status": 2,
            "current_version": "0",
            "create_at": 1645502043,
            "has_deploy_strategy": false,
            "user_profile_path_list": null,
            "game_type": "pc",
            "default_key_mapping_list": null
        },
        "game_version_list": [
            {
                "game_id": "7064461037646xxxxxx",
                "custom_game_id": "game01",
                "version_id": "7067374083201xxxxxx",
                "download_url": "https://xxx-file.xxxxxx.com/cloudgame/xxxxxx.apk?x-expires=25862xxxxxx&x-signature=XXXXXX",
                "package_name": "com.image.name",
                "version_code": 235,
                "md5": "5403bf7211ec9fb042a6825876xxxxxx",
                "package_size": 215597,
                "create_time": 1645502043,
                "update_time": 1645502160
            }
        ]
    }
}