服务容量详情--云游戏-火山引擎

文档中心

立即注册

导航

服务容量详情

最近更新时间：2025.01.20 15:42:49首次发布时间：2024.04.19 13:53:04

本接口支持获取游戏维度和用户维度的资源容量信息。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=GetGameCapacity&Version=2023-03-18

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetGameCapacity`	接口名称。当前 API 的名称为 `GetGameCapacity`。
Version	String	是	`2023-03-18`	接口版本。当前 API 的版本为 `2023-03-18`。
ProductId	String	是	`80927301923801`	游戏所属的业务 ID，可通过云游戏手游控制台『业务管理』页面获取。
GameIdList	Array of String	是	`["9028318","298103701"]`	游戏 ID 列表，可通过调用 ListGame 接口获取（数组长度最大为20）。`GameIdList` 和 `CustomGameIdList` 二选一，同时指定时，`GameIdList` 优先。
CustomGameIdList	Array of String	是	`["2093812893"]`	用户自定义游戏 ID 列表，可通过调用 ListGame 接口获取（数组长度最大为20）。`GameIdList` 和 `CustomGameIdList` 二选一，同时指定时，`GameIdList` 优先。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
GameCapacityList	Array of GameCapacityList	`-`	按游戏维度查询到的资源用量列表
UserCapacityList	Array of UserCapacityList	`-`	按用户标签维度查询到的资源用量列表

GameCapacityList

参数	类型	示例值	描述
GameId	String	`7085311516068xxxxxx`	游戏 ID
CustomGameId	String	`hh`	用户自定义游戏 ID
ChannelId	String	`iOS`	渠道 ID
CapacityList	Array of CapacityList	`-`	游戏资源用量列表

UserCapacityList

参数	类型	示例值	描述
GameId	String	`7085311516068xxxxxx`	游戏 ID
CustomGameId	String	`hh`	用户自定义游戏 ID
ConfigurationCode	String	`ARMSoC_Advanced`	实例套餐 ID： ARMSoC_Standard（基础型） ARMSoC_General（通用型） ARMSoC_Enhanced（加强型） ARMSoC_Advanced（旗舰型）
UsedNum	Integer	`0`	已使用量
UserTag	String	`user_group_01`	业务方指定的用户标签

CapacityList

参数	类型	示例值	描述
ConfigurationCode	String	`ARMSoC_Advanced`	实例套餐 ID： ARMSoC_Standard（基础型） ARMSoC_General（通用型） ARMSoC_Enhanced（加强型） ARMSoC_Advanced（旗舰型）
ApplyNum	Integer	`1`	已订购实例总量
UsedNum	Integer	`0`	已使用实例总量

请求示例

GET https://open.volcengineapi.com?Action=GetGameCapacity&Version=2023-03-18&ProductId=1495988208461xxxxxx&GameIdList=7085311516068xxxxxx

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetGameCapacity",
        "Version": "2023-03-18",
        "Service": "veGame",
        "Region": "cn-north-1"
    },
    "Result": {
        "GameCapacityList": [
            {
                "GameId": "7085311516068xxxxxx",
                "CustomGameId": "hh",
                "ChannelId": "iOS",
                "CapacityList": [
                    {
                        "ConfigurationCode": "ARMSoC_Advanced",
                        "ApplyNum": 1,
                        "UsedNum": 0
                    }
                ]
            }
        ],
        "UserCapacityList": [
            {
                "GameId": "7085311516068xxxxxx",
                "CustomGameId": "hh",
                "ConfigurationCode": "ARMSoC_Advanced",
                "UsedNum": 0,
                "UserTag": "user_group_01"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。