开始放置游戏服务器会话

最近更新时间:2020-03-06 17:54:06

1. 接口描述

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

本接口(StartGameServerSessionPlacement)用于开始放置游戏服务器会话

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:StartGameServerSessionPlacement。
Version String 公共参数,本接口取值:2019-11-12。
Region String 公共参数,详见产品支持的 地域列表
PlacementId String 开始部署游戏服务器会话的唯一标识符
GameServerSessionQueueName String 游戏服务器会话队列名称
MaximumPlayerSessionCount Integer 游戏服务器允许同时连接到游戏会话的最大玩家数量
DesiredPlayerSessions.N Array of DesiredPlayerSession 玩家游戏会话信息
GameProperties.N Array of GameProperty 玩家游戏会话属性
GameServerSessionData String 游戏服务器会话数据
GameServerSessionName String 游戏服务器会话名称
PlayerLatencies.N Array of PlayerLatency 玩家延迟

3. 输出参数

参数名称 类型 描述
GameServerSessionPlacement GameServerSessionPlacement 游戏服务器会话放置
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 开始放置游戏服务器会话

输入示例

https://gse.tencentcloudapi.com/?Action=StartGameServerSessionPlacement
&PlacementId=PlacementId-3a7d34cd-5240-11ea-b02a-3464a91513fe
&GameServerSessionQueueName=PlacementTwo
&MaximumPlayerSessionCount=100
&<公共请求参数>

输出示例

{
  "Response": {
    "GameServerSessionPlacement": {
      "DnsName": "",
      "EndTime": null,
      "GameProperties": [],
      "GameServerSessionData": "",
      "GameServerSessionId": "",
      "GameServerSessionName": "",
      "GameServerSessionQueueName": "PlacementTwo",
      "GameServerSessionRegion": "",
      "IpAddress": "",
      "MatchmakerData": "",
      "MaximumPlayerSessionCount": 100,
      "PlacedPlayerSessions": [],
      "PlacementId": "PlacementId-3a7d34cd-5240-11ea-b02a-3464a91513fe",
      "PlayerLatencies": [],
      "Port": 0,
      "StartTime": "2020-02-18T11:17:23Z",
      "Status": "PENDING"
    },
    "RequestId": "84708eb1-0247-43f8-834e-c7edfdsfdgd53"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
目录