游戏列表查询 ListGame--云游戏-火山引擎

文档中心

立即注册

导航

游戏列表查询 ListGame

最近更新时间：2025.09.15 16:05:13首次发布时间：2022.03.01 17:31:35

查询当前账号下的游戏信息。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListGame&Version=2022-02-10

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListGame
Version	Query	String	是	公共参数，OpenAPI 接口版本	2022-02-10
product_id	Query	String	否	筛选条件，游戏所属的业务 ID	可在「云游戏控制台-业务管理」中获取
custom_game_id	Query	String	否	筛选条件，用户自定游戏 ID	在注册游戏时指定
offset	Query	Int64	否	分页偏移量	例：0
count	Query	Int64	否	单页数量	默认值：10

返回结果

通用返回参数，参考 ResponseMetadata 结构说明。
Result 字段包含以下参数：

字段	类型	说明
total	Int64	查询到的游戏总数
row	`List<Game>`	游戏信息列表，参考以下 Game 结构说明

Game 结构说明

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

DeployStrategy 结构说明

字段	类型	说明
configuration_code	String	实例套餐 ID
configuration_name	String	套餐名称
priority	Int	实例套餐优先级，数字越小优先级越高

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "Action": "ListGame",
        "Region": "cn-north-1",
        "RequestId": "202202161057240102252431250604CD83",
        "Service": "veGame",
        "Version": "2022-02-10"
    },
    "Result": {
        "row": [
            {
                "product_id": "1493570375567xxxxxx",
                "game_id": "7064461037747xxxxxx",
                "custom_game_id": "game01",
                "game_name": "大游戏",
                "package_name": "com.game.name",
                "game_rotation": "landscape",
                "game_status": 2,
                "current_version": "7225207044511xxxxxx",
                "has_deploy_strategy": true,
                "strategy_list": [
                    {
                        "game_id": "",
                        "configuration_code": "ARMSoC_Advanced",
                        "configuration_name": "旗舰型",
                        "priority": 1
                    }
                ],
                "framework_app_id_list": [
                    "7137607469433xxxxxx",
                    "7139881358947xxxxxx"
                ],
                "inner_fw_id_list": [
                    "7089049711268xxxxxx",
                    "7089049711268xxxxxx"
                ],
                "user_profile_path_list": null,
                "default_key_mapping_list": null,
                "game_type": "android",
                "create_at": 1644930060,
                "update_at": 1644930060
            },
            {
                "product_id": "1493136114825xxxxxx",
                "game_id": "7064461037646xxxxxx",
                "custom_game_id": "game02",
                "game_name": "小游戏",
                "package_name": "com.game.name",
                "game_rotation": "portrait",
                "game_status": 2,
                "current_version": "7225088935267xxxxxx",
                "has_deploy_strategy": false,
                "framework_app_id_list": [],
                "inner_fw_id_list": [],
                "user_profile_path_list": null,
                "default_key_mapping_list": null,
                "game_type": "android",
                "create_at": 1644826614,
                "update_at": 1644826614
            }
        ],
        "total": 2
    }
}