1. 接口描述
接口请求域名： gs.tencentcloudapi.com 。
创建会话
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateSession。 |
| Version | 是 | String | 公共参数，本接口取值：2019-11-18。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| UserId | 是 | String | 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变） 示例值：xyz789 |
| GameId | 是 | String | 【已废弃】只在TrylockWorker时生效 示例值：game-abcd1234 |
| GameRegion | 否 | String | 【已废弃】只在TrylockWorker时生效 示例值：ap-guangzhou |
| GameParas | 否 | String | 游戏参数 示例值：StartFor=1 |
| ClientSession | 否 | String | 客户端session信息，从JSSDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空 示例值：e30= |
| Resolution | 否 | String | 分辨率,，可设置为1080p或720p或1920x1080格式 示例值：1080p |
| ImageUrl | 否 | String | 背景图url，格式为png或jpeg，宽高1920*1080 示例值：http://ip:port/test.png |
| SetNo | 否 | Integer | 【已废弃】 示例值：1 |
| Bitrate | 否 | Integer | 【已废弃】 示例值：2 |
| MaxBitrate | 否 | Integer | 单位Mbps，动态调整最大码率建议值，会按实际情况调整 示例值：4 |
| MinBitrate | 否 | Integer | 单位Mbps，动态调整最小码率建议值，会按实际情况调整 示例值：2 |
| Fps | 否 | Integer | 帧率，可设置为30、45、60、90、120、144 示例值：60 |
| UserIp | 否 | String | 【必选】用户IP，用户客户端的公网IP，用于就近调度，不填将严重影响用户体验 示例值：125.127.178.228 |
| Optimization | 否 | Integer | 【已废弃】优化项，便于客户灰度开启新的优化项，默认为0 示例值：0 |
| HostUserId | 否 | String | 【互动云游】游戏主机用户ID 示例值：abc123 |
| Role | 否 | String | 【互动云游】角色；Player表示玩家；Viewer表示观察者 示例值：Player |
| GameContext | 否 | String | 游戏相关参数 示例值：{} |
| RunMode | 否 | String | 云端运行模式。 RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。 示例值：RunWithoutClient |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ServerSession | String | 服务端session信息，返回给JSSDK 示例值：e30= |
| RoleNumber | String | 【已废弃】 示例值：1 |
| Role | String | 【互动云游】角色；Player表示玩家；Viewer表示观察者 示例值：Player |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 CreateSession示例
锁定实例后，创建会话，以连接实例
输入示例
POST / HTTP/1.1
Host: gs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSession
<公共请求参数>
{
"GameRegion": "字符串型",
"GameId": "字符串型",
"UserId": "字符串型",
"ClientSession": "字符串型"
}输出示例
{
"Response": {
"RoleNumber": "1",
"ServerSession": "abc",
"Role": "Player",
"RequestId": "req123"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.LockTimeout | 锁定机器超时或未调用TrylockWorker。 |
| FailedOperation.ProcessTimeout | 处理超时。 |
| FailedOperation.SlowDown | 请降低访问频率。 |
| FailedOperation.Timeout | 操作超时。 |
| FailedOperation.TooFrequently | 请求太频繁。 |
| InternalError | 内部错误。 |
| InvalidParameter.JsonParseError | Json解析失败。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded.Role | 【多人游戏】对应的角色人数超过限制。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.NoIdle | 没有空闲机器。 |
| ResourceNotFound.SessionNotFound | 会话未找到。 |
| ResourceUnavailable.Initialization | 机器还在初始化中。 |
| UnsupportedOperation.Stopping | 退出游戏中。 |
