GET (/serviceconfigs/{scid}/hoppers/{name}/stats)
获取漏斗的统计数据。
重要提示:
此方法适用于协定 103 或更高版本,并且每个请求都需要一个 X-Xbl-Contract-Version: 103 或更高版本的标头元素。
备注
此 HTTP/REST 方法在服务配置 ID (SCID) 级别从已命名的漏斗中获取统计数据。 此方法可由 Microsoft.Xbox.Services.Matchmaking.MatchmakingService.GetHopperStatisticsAsync API 包装。
URI 参数
参数 | 类型 | 说明 |
---|---|---|
scid | GUID | 会话的服务配置标识符 (SCID)。 |
名称 | 字符串 | 漏斗的名称。 |
授权
类型 | 必需 | 说明 | 缺少时的响应 |
---|---|---|---|
XUID(用户 ID) | 是 | 发出请求的用户必须是票证引用的票证会话的成员。 | 403 |
权限和设备类型 | 是 | 当用户的 deviceType 设置为主机时,只允许在声明中具有多人游戏权限的用户调用匹配服务。 | 403 |
游戏 ID/购买证明/设备类型 | 是 | 所匹配的游戏必须允许匹配指定的游戏声明与设备类型组合。 | 403 |
HTTP 状态代码
请求正文
对象不会在此请求的正文中发送。
响应正文
成员 | 类型 | 说明 |
---|---|---|
hopperName | 字符串 | 所选漏斗的名称。 |
waitTime | 32 位有符号整数 | 漏斗的平均匹配时间(以秒计的整数)。 |
population | 32 位有符号整数 | 正在漏斗中等待匹配的人数。 |
示例响应
{
"hopperName":"contosoawesome2",
"waitTime":30,
"population":1
}