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

文档中心

立即注册

导航

业务容量详情

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

查询当前业务已订购实例总量和已使用实例总量，用于计算可使用的并发服务容量。

注意事项

只在业务订购实例资源后，查询才会有返回值；如果实例资源被退订，查询返回的数量为 0，整个结构体为空。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetProductCapacity`	接口名称。当前 API 的名称为 `GetProductCapacity`。
Version	String	是	`2023-03-18`	接口版本。当前 API 的版本为 `2023-03-18`。
ProductId	String	是	`09804810419`	游戏所属的业务 ID，可通过云游戏控制台『云游戏手游-业务管理』页面获取。

返回参数

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

参数	类型	示例值	描述
CapacityList	Array of CapacityList	`-`	业务资源用量列表

CapacityList

参数类型示例值描述

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

ConfigurationCode

String

ARMSoC_Advanced

实例套餐 ID：

ARMSoC_Standard（基础型）
ARMSoC_General（通用型）
ARMSoC_Enhanced（加强型）
ARMSoC_Advanced（旗舰型）

ApplyNum Integer 10 已订购实例总量

UsedNum Integer 5 已使用实例总量

请求示例

GET https://open.volcengineapi.com?Action=GetProductCapacity&Version=2023-03-18&ProductId=901830913

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetProductCapacity",
        "Version": "2023-03-18",
        "Service": "veGame",
        "Region": "cn-north-1"
    },
    "Result": {
        "CapacityList": [
            {
                "ConfigurationCode": "ARMSoC_Advanced",
                "ApplyNum": 10,
                "UsedNum": 5
            }
        ]
    }
}

错误码

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