查询最大队列长度 GetDailyMaxQueueLength--云游戏-火山引擎

文档中心

立即注册

导航

查询最大队列长度 GetDailyMaxQueueLength

最近更新时间：2025.01.20 15:42:50首次发布时间：2024.11.11 15:08:25

在游戏排队场景下，查询指定业务某个资源套餐下每日的最大队列长度。

注意事项

支持查询当前时间前 180 天至前 1 天的数据。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetDailyMaxQueueLength`	接口名称。当前 API 的名称为 `GetDailyMaxQueueLength`。
Version	String	是	`2023-03-18`	接口版本。当前 API 的版本为 `2023-03-18`。
ProductId	String	是	`1495988208461xxxxxx`	游戏所属的业务 ID，用于查询业务维度数据。您可在云游戏控制台的业务管理页面获取该值。
ConfigurationCode	String	是	`ARMSoC_Enhanced`	实例资源套餐 ID，取值如下所示： `ARMSoC_Standard`：基础型 `ARMSoC_General`：通用型 `ARMSoC_Enhanced`：加强型 `ARMSoC_Advanced`：旗舰型
StartAt	String	是	`2024-11-03`	查询开始时间，格式 YYYY-MM-DD。
StopAt	String	是	`2024-11-04`	查询结束时间，格式 YYYY-MM-DD。

返回参数

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

参数	类型	示例值	描述
Total	Long	`2`	查询到的数据总量。
DailyUserQueueInfo	Array of DailyUserQueueInfo	`-`	队列长度信息列表。

DailyUserQueueInfo

参数	类型	示例值	描述
Date	String	`2024-11-04`	日期。
MaxQueueLength	Long	`1`	当日最大队列长度。

请求示例

GET https://open.volcengineapi.com?Action=GetDailyMaxQueueLength&Version=2023-03-18&ProductId=1495988208461xxxxxx&ConfigurationCode=ARMSoC_Enhanced&StartAt=2024-11-03&StopAt=2024-11-04

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetDailyMaxQueueLength",
        "Version": "2023-03-18",
        "Service": "vegame",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 2,
        "DailyUserQueueInfo": [
            {
                "Date": "2024-11-03",
                "MaxQueueLength": 0
            },
            {
                "Date": "2024-11-04",
                "MaxQueueLength": 1
            }
        ]
    }
}

错误码

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