查询游戏时长 ListGameSession--云游戏-火山引擎

文档中心

立即注册

导航

查询游戏时长 ListGameSession

最近更新时间：2025.09.15 16:05:13首次发布时间：2021.10.15 14:01:12

查询某段时间内指定游戏发生的游戏会话时长（支持查询最近一个月内的数据）。

注意

由于数据产生可能有延迟（一般在10秒以内），如果在开始游戏后就进行查询，可能会查询不到数据。请在当次游戏结束后（收到了服务端回调），再进行游戏时长查询。
如果游戏时间很短，在游戏结束后立即查询游戏时长，可能会出现 “游戏结束时间=游戏开始时间” 的情况，请在游戏结束后一段时间（约1分钟）再查询。

请求说明

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

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListGameSession
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 时，可不传入
reserved_id	Query	String	否	筛选条件，资源预锁定 ID	可通过调用 PreAllocateResource 接口获取，或通过客户端 SDK `start()` 接口成功回调
round_id	Query	String	否	筛选条件，当次游戏过程标识	通过客户端启动游戏时传入；详细信息，参考客户端 SDK start() 接口使用说明
start_at	Query	Timestamp	是	查询开始时间	秒级时间戳
stop_at	Query	Timestamp	是	查询结束时间	秒级时间戳

返回结果

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

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

List<GameSession> 结构说明

字段	类型	说明
game_id	String	游戏 ID
custom_game_id	String	用户自定义游戏 ID
reserved_id	String	资源预锁定 ID
round_id	String	当次游戏过程标识
start_at	Timestamp	游戏推流开始时间，秒级时间戳
stop_at	Timestamp	游戏推流终止时间，秒级时间戳

示例

请求示例

GET https://open.volcengineapi.com?Action=ListGameSession
&Version=2022-02-10
&game_id=1428188852161xxxxxx
&start_at=1638879651
&stop_at=1639047840
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "ListGameSession",
        "Region": "cn-north-1",
        "RequestId": "20220408151310010212063032144550B9",
        "Service": "veGame",
        "Version": "2022-02-10"
    },
    "Result": {
        "row": [
            {
                "game_id": "7068174254205xxxxxx",
                "custom_game_id": "yyy",
                "reserved_id": "7083793914380xxxxxx",
                "round_id": "001",
                "start_at": 1649399462,
                "stop_at": 1649399585
            }
        ],
        "total": 1
    }
}