查询游戏服务器会话的放置

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

1. 接口描述

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

本接口(DescribeGameServerSessionPlacement)用于查询游戏服务器会话的放置

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeGameServerSessionPlacement。
Version String 公共参数,本接口取值:2019-11-12。
Region String 公共参数,详见产品支持的 地域列表
PlacementId String 游戏服务器会话放置的唯一标识符

3. 输出参数

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

4. 示例

示例1 查询游戏服务器会话的放置

输入示例

https://gse.tencentcloudapi.com/?Action=DescribeGameServerSessionPlacement
&PlacementId=PlacementId-3a7d34cd-5240-11ea-b02a-3464sdf513fe
&<公共请求参数>

输出示例

{
  "Response": {
    "GameServerSessionPlacement": {
      "DnsName": "",
      "EndTime": "2020-02-18T11:27:23Z",
      "GameProperties": [
        {
          "Key": "Key-3a7d34d0-5240-11ea-a3b0-3464afff13fe",
          "Value": "Value-3a7d34d1-5240-11ea-9466-344654391513fe"
        }
      ],
      "GameServerSessionData": "GameServerSessionData-3a7d34d2-5240-11ea-8dd4-3464afdf1513fe",
      "GameServerSessionId": "",
      "GameServerSessionName": "GameServerSessionName-3a7d34d3-5240-11ea-8564-3464sd1513fe",
      "GameServerSessionQueueName": "PlacementTwo",
      "GameServerSessionRegion": "",
      "IpAddress": "",
      "MatchmakerData": "",
      "MaximumPlayerSessionCount": 100,
      "PlacedPlayerSessions": [],
      "PlacementId": "PlacementId-3a7d34cd-5240-11ea-b02a-3464sdf513fe",
      "PlayerLatencies": [
        {
          "LatencyInMilliseconds": 10000,
          "PlayerId": "Player-3a7d34d4-5240-11ea-a2ee-3464a91513fe",
          "RegionIdentifier": "ap-shanghai"
        }
      ],
      "Port": 0,
      "StartTime": "2020-02-18T11:17:23Z",
      "Status": "TIMED_OUT"
    }
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
ResourceNotFound 资源不存在。
目录