查询实时队列长度 GetUserQueueLength--云游戏-火山引擎

文档中心

立即注册

导航

查询实时队列长度 GetUserQueueLength

最近更新时间：2025.02.14 11:25:17首次发布时间：2025.02.14 10:56:11

在游戏排队场景中，查询指定业务下某个资源套餐当前的实时队列长度。

使用说明

本接口用于查询实时数据，如需查询过往的离线排队数据，请使用 GetDailyMaxQueueLength 接口。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetUserQueueLength`	接口名称。当前 API 的名称为 `GetUserQueueLength`。
Version	String	是	`2023-03-18`	接口版本。当前 API 的版本为 `2023-03-18`。
ProductId	String	是	`1495988208461******`	游戏所属的业务 ID。您可在云游戏控制台的业务管理页面获取该值。
ConfigurationCode	String	是	`ARMSoC_Enhanced`	实例资源套餐 ID，取值如下所示： `ARMSoC_Standard`：基础型 `ARMSoC_General`：通用型 `ARMSoC_Enhanced`：加强型 `ARMSoC_Advanced`：旗舰型

返回参数

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

参数	类型	示例值	描述
QueueLength	Long	`1`	当前队列长度

请求示例

GET https://open.volcengineapi.com?Action=GetUserQueueLength&Version=2023-03-18&ProductId=1495988208461******&ConfigurationCode=ARMSoC_Enhanced

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetUserQueueLength",
        "Version": "2023-03-18",
        "Service": "veGame",
        "Region": "cn-north-1"
    },
    "Result": {
        "QueueLength": 1
    }
}

错误码

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