1. 接口描述
接口请求域名： car.tencentcloudapi.com 。
本接口用于创建会话。接口超时时间：5秒。
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateSession。 |
| Version | 是 | String | 公共参数，本接口取值：2022-01-10。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| UserId | 是 | String | 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变） 示例值：cg_user |
| UserIp | 是 | String | 用户IP，用户客户端的公网IP，用于就近调度 示例值：125.127.178.228 |
| ClientSession | 否 | String | 客户端session信息，从SDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空 示例值：eyJhYmMiOjEyM30= |
| RunMode | 否 | String | 云端运行模式。 RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。 示例值：RunWithoutClient |
| ApplicationParameters | 否 | String | 应用启动参数。 如果请求的是多应用共享项目，此参数生效； 如果请求的是关闭预启动的单应用独享项目，此参数生效； 如果请求的是开启预启动的单应用独享项目，此参数失效。 注意：在此参数生效的情况下，将会被追加到控制台应用或项目配置的启动参数的后面。 例如，对于某关闭预启动的单应用独享项目，若在控制台中项目配置的启动参数为bar=0，而ApplicationParameters参数为foo=1，则实际应用启动参数为bar=0 foo=1。 示例值：StartFor=1 |
| HostUserId | 否 | String | 【多人互动】房主用户ID，在多人互动模式下为必填字段。 如果该用户是房主，HostUserId需要和UserId保持一致； 如果该用户非房主，HostUserId需要填写房主的HostUserId。 示例值：host_user_id |
| Role | 否 | String | 【多人互动】角色。 Player：玩家（可通过键鼠等操作应用） Viewer：观察者（只能观看，无法操作） 示例值：Player |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ServerSession | String | 服务端session信息，返回给SDK 示例值：eyJhYmMiOjEyM30= |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 CreateSession示例
CreateSession示例
输入示例
POST / HTTP/1.1
Host: car.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSession
<公共请求参数>
{
"UserIp": "125.127.178.228",
"ClientSession": "eyJhYmMiOjEyM30=",
"UserId": "cg_user"
}输出示例
{
"Response": {
"ServerSession": "eyJ4dHoiOjc4OX0=",
"RequestId": "fcf4146f-64d3-496c-88dc-d12f832de313"
}
}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 | 未申请并发或申请后超时。 |
| FailedOperation.PathNotFound | 路径无法找到 |
| FailedOperation.ProcessTimeout | 处理超时。 |
| FailedOperation.SlowDown | 该UserId请求正在处理中，请稍后再试。 |
| InternalError | 内部错误。 |
| InvalidParameter.JsonParseError | Json 解析失败。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded.Role | 【多人互动】对应的角色人数超过限制。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.NoIdle | 没有空闲并发。 |
| ResourceNotFound.SessionNotFound | 未找到会话。 |
| ResourceUnavailable.Initialization | 初始化中。 |
| UnsupportedOperation.Stopping | 销毁会话中。 |
