查询游戏服务器会话详情列表

最近更新时间:2020-05-18 08:02:20

1. 接口描述

接口请求域名: gse.tencentcloudapi.com 。

本接口(DescribeGameServerSessionDetails)用于查询游戏服务器会话详情列表

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeGameServerSessionDetails。
Version String 公共参数,本接口取值:2019-11-12。
Region String 公共参数,详见产品支持的 地域列表
AliasId String 别名ID
FleetId String 舰队ID
GameServerSessionId String 游戏服务器会话ID
Limit Integer 单次查询记录数上限
NextToken String 页偏移,用于查询下一页
StatusFilter String 游戏服务器会话状态(ACTIVE,ACTIVATING,TERMINATED,TERMINATING,ERROR)

3. 输出参数

参数名称 类型 描述
GameServerSessionDetails Array of GameServerSessionDetail 游戏服务器会话详情列表
注意:此字段可能返回 null,表示取不到有效值。
NextToken String 页偏移,用于查询下一页
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取游戏会话详情列表

获取游戏会话详情列表

输入示例

https://gse.tencentcloudapi.com/?Action=DescribeGameServerSessionDetails
&FleetId=fleet-test00-1223
&Limit=5
&NextToken=nextToken-test01-tt
&<公共请求参数>

输出示例

{
  "Response": {
    "GameServerSessionDetails": [
      {
        "GameServerSession": {
          "CreationTime": "2019-12-06T10:03:50Z",
          "CreatorId": "c1",
          "CurrentPlayerSessionCount": 0,
          "DnsName": "",
          "FleetId": "fleet-pro4extc-f1hiuzry",
          "GameProperties": [],
          "GameServerSessionData": "testdata",
          "GameServerSessionId": "qcs::gse:ap-shanghai:uin/1112222:gameserversession/fleet-qp3ga-p70zzzz/gssess-aaaa-ilqsssu/PlacementId-124ddda-4e28-1111-222b-abcde",
          "IpAddress": "0000.0.0.0",
          "MatchmakerData": "",
          "MaximumPlayerSessionCount": 10,
          "Name": "",
          "PlayerSessionCreationPolicy": "ACCEPT_ALL",
          "Port": 8000,
          "Status": "TERMINATED",
          "StatusReason": "",
          "TerminationTime": "2019-12-08T02:53:27Z"
        },
        "ProtectionPolicy": "FullProtection"
      }
    ],
    "NextToken": "",
    "RequestId": "0a6ce70b-ffc8-4b9a-9255-d1915test"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
目录