查询累计使用实例数--云游戏-火山引擎

文档中心

立即注册

导航

查询累计使用实例数

最近更新时间：2025.01.20 15:42:49首次发布时间：2023.08.18 14:16:24

获取业务维度或游戏维度在指定时间内（按天粒度）累计使用的实例数量。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	GetCgUsedNum
Version	Query	String	是	公共参数，OpenAPI 接口版本	2023-03-18
ProductId	Query	String	否	游戏所属的业务 ID（查询业务维度数据）	可通过云游戏控制台『业务管理』页面获取
GameId	Query	String	否	游戏 ID（查询游戏维度数据）	可通过调用 ListGame 接口获取当传入 custom_game_id 时，可不传入（以 game_id 优先）
CustomGameId	Query	String	否	用户自定义游戏 ID（查询游戏维度数据）	可通过调用 ListGame 接口获取当传入 game_id 时，可不传入
StartAt	Query	Timestamp	是	查询开始时间（支持查询最近180天的数据）	秒级时间戳，仅能支持按天粒度查询
StopAt	Query	Timestamp	是	查询结束时间（支持查询最近180天的数据）	秒级时间戳，仅能支持按天粒度查询

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
Total	Int64	查询到的累计使用的实例数量

示例

请求示例

GET https://open.volcengineapi.com?Action=GetCgUsedNum
&Version=2023-03-18
&GameId=7085311516068xxxxxx
&StartAt=1638879651
&StopAt=1639047840
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "GetCgUsedNum",
        "Region": "cn-north-1",
        "RequestId": "2022030114452501022511001103FD08F9",
        "Service": "veGame",
        "Version": "2023-03-18"
    },
    "Result": {
        "Total": 5
    }
}