创建应用会话，并启动一个应用进程，返回会话信息。
接口说明
- 创建会话成功后，事件类型为
APP_START。应用启动的结果会通过以下消息通知。注意 仅限 API 对接模式，不适用于 H5 SDK 对接模式。
| 名称 | 类型 | 是否必选 | 说明 |
|---|---|---|---|
| success | Boolean | 是 | 启动是否成功。 取值： true：启动成功。 false：启动失败。 |
| eventType | String | 是 | 事件类型。 |
| customSessionId | String | 是 | 自定义会话 ID。 |
| platformSessionId | String | 是 | 平台会话 ID。 |
| customTaskId | String | 否 | 自定义任务 ID。 |
| platformTaskId | String | 否 | 平台任务 ID。 |
| eventDetail | Object[EventDetail] | 是 | 事件详情。 |
| errorMessage | Object[EventDetail] | 否 | 错误详情。 当启动失败时，返回该参数。 |
| tags | Map<String,String> | 否 | 会话标签。 |
EventDetail 数据结构如下所示。
| 名称 | 类型 | 是否必选 | 说明 |
|---|---|---|---|
| appId | String | 是 | 应用 ID。 |
| appVersion | String | 是 | 应用版本 ID。 |
| appBizConfig | String | 否 | 平台适配时自定义的业务配置数据。 |
| streamingToken | String | 否 | 串流鉴权信息，存在串流服务时才会携带。 |
| endpoint | Object[Endpoint] | 否 | 事件详情。 当启动成功时，返回该参数。 |
Endpoint 数据结构如下所示。
| 名称 | 类型 | 是否必选 | 说明 |
|---|---|---|---|
| name | String | 是 | 名称。 |
| type | String | 是 | 类型。 |
| accessHost | String | 是 | 终端节点 IP 地址。 |
| accessPort | String | 是 | 终端节点端口。 |
| isp | String | 是 | 运营商标识。 取值： MOBILE：中国移动。 UNICOM：中国联通。 TELECOM：中国电信。 BGP：多线网络。 |
| districtId | String | 是 | 区域 ID。 |
| regionId | String | 是 | 地域 ID。 |
ErrorMessage 数据结构如下所示。
| 名称 | 类型 | 是否必选 | 说明 |
|---|---|---|---|
| code | String | 是 | 错误码。 |
| msg | String | 是 | 错误详情。 |
- 含有串流的业务创建会话成功后，事件类型为
APP_STREAMING_INIT。串流初始化信息通过以下消息通知。注意 仅限 API 对接模式，不适用于 H5 SDK 对接模式。
| 名称 | 类型 | 是否必选 | 说明 |
|---|---|---|---|
| success | Boolean | 是 | 串流初始化是否成功。 取值： true：初始化成功。 false：初始化失败。 |
| eventType | String | 是 | 事件类型。 |
| customSessionId | String | 是 | 自定义会话 ID。 |
| platformSessionId | String | 是 | 平台会话 ID。 |
| customTaskId | String | 否 | 自定义任务 ID。 |
| platformTaskId | String | 否 | 平台任务 ID。 |
| eventDetail | Object[EventDetail] | 是 | 事件详情。 |
EventDetail 数据结构如下所示。
| 名称 | 类型 | 是否必选 | 说明 |
|---|---|---|---|
| appId | String | 是 | 应用 ID。 |
| appVersion | String | 是 | 应用版本 ID。 |
| appBizConfig | String | 否 | 平台适配时自定义的业务配置数据。 |
| streamingToken | String | 否 | 串流鉴权信息，存在串流服务时才会携带。 |
| eventDetail | Object[EventDetail] | 否 | 事件详情。 当会话启动成功时，返回该参数。 |
| errorMessage | Object | 否 | 错误详情. 当会话启动失败时，返回该参数。 |
Endpoint 数据结构如下所示。
| 名称 | 类型 | 是否必选 | 说明 |
|---|---|---|---|
| name | String | 是 | 名称。 |
| type | String | 是 | 类型。 |
| accessHost | String | 是 | 终端节点 IP 地址。 |
| accessPort | String | 是 | 终端节点端口。 |
| isp | String | 是 | 运营商标识。 取值： MOBILE：中国移动。 UNICOM：中国联通。 TELECOM：中国电信。 BGP：多线网络。 |
| districtId | String | 是 | 区域 ID。 |
| regionId | String | 是 | 地域 ID。 |
ErrorMessage 数据结构如下所示。
| 名称 | 类型 | 是否必选 | 说明 |
|---|---|---|---|
| code | String | 是 | 错误码。 |
| msg | String | 是 | 错误详情。 |
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AppId | string | 是 | 应用 ID。 | 13027XXXX |
| AppVersion | string | 否 | 应用版本 ID。 说明
当您未指定生效版本时，默认应用最新版本。
| 35067XXXX |
| CustomUserId | string | 否 | 自定义用户 ID，最大长度不超过 64 个字符。 用于业务对用户维度做相应的操作。 说明
当应用类型为 end_game、hand_game时，本参数必填。
| 2YEF0XXXX |
| CustomSessionId | string | 是 | 自定义会话 ID，保证请求幂等性。 从您的客户端生成一个参数值，确保不同请求间该参数值唯一。 说明
支持 ASCII 字符，且不能超过 64 个字符。
| 1ADE0XXXX |
| ClientIp | string | 否 | 业务的客户端 IP，比如云游戏场景中玩家的 IP。 | 192.168.XXX.XXX |
| StartParameters | array<object> | 否 | 启动参数。 | |
| object | 否 | |||
| Key | string | 否 | 目前支持的枚举值包括：
| startArgument |
| Value | string | 否 | key 对应的取值。 | exampleValue |
| SystemInfo | array<object> | 否 | 系统信息，如客户端侧机型等信息。 | |
| object | 否 | |||
| Key | string | 否 | key 取值支持自定义。约定以下保留字：
| utdid |
| Value | string | 否 | key 对应的取值。 | OE0usD+APXXXX |
| Timeout | long | 否 | 按量付费模式按需生产资源的超时时间。 取值范围 [900, 43200]秒，默认值 1800。 | 1800 |
| EnablePostpaid | boolean | 否 | 按量付费模式下创建会话时，是否按需生产资源。取值范围：
| false |
| ProjectId | string | 否 | 项目 ID。如果已将应用关联到项目，创建会话时需填写正确的项目 ID。 | d9a8**** |
| AdapterFileId | string | 否 | 适配文件 ID。此功能灰度开放，如未约定使用请勿传入。 | 501716211209548966XXXX |
| DistrictId | string | 否 | 区域 ID。取值：
| huadong |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986",
"CustomSessionId": "1ADE0XXXX",
"PlatformSessionId": "100XXXX",
"AppId": "13027XXXX",
"AppVersion": "35067XXXX"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-20 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2022-03-03 | 新增 OpenAPI | 查看变更详情 |