加入游戏服务器会话

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

1. 接口描述

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

本接口(JoinGameServerSession)用于加入游戏服务器会话

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:JoinGameServerSession。
Version String 公共参数,本接口取值:2019-11-12。
Region String 公共参数,详见产品支持的 地域列表
GameServerSessionId String 游戏服务器会话ID
PlayerId String 玩家ID
PlayerData String 玩家自定义信息

3. 输出参数

参数名称 类型 描述
PlayerSession PlayerSession 玩家会话
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建单个玩家会话

创建单个玩家会话

输入示例

https://gse.tencentcloudapi.com/?Action=JoinGameServerSession
&GameServerSessionId=qcs::gse:ap-shanghai:uin/1112222:gameserversession/fleet-qp3ga-p70zzzz/gssess-aaaa-ilqsssu/PlacementId-124ddda-4e28-1111-222b-abcde
&PlayerData=testData
&PlayerId=testPlayer
&<公共请求参数>

输出示例

{
  "Response": {
    "PlayerSession": {
      "CreationTime": "2019-12-05T15:15:33Z",
      "DnsName": "",
      "FleetId": "fleet-sss-test01",
      "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",
      "PlayerData": "imangozhang",
      "PlayerId": "100",
      "PlayerSessionId": "psess-d44990-test5",
      "Port": "8000",
      "Status": "RESERVED",
      "TerminationTime": null
    },
    "RequestId": "0fffff4-oooo-43333d-9222-testaaa"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

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