文档

CreateAppSession - 创建应用会话

更新时间:

创建应用会话,并启动一个应用进程,返回会话信息。

接口说明

  • 创建会话成功后,事件类型为APP_START。应用启动的结果会通过以下消息通知。
    注意 仅限 API 对接模式,不适用于 H5 SDK 对接模式。
名称类型是否必选说明
successBoolean启动是否成功。
取值:
true:启动成功。
false:启动失败。
eventTypeString事件类型。
customSessionIdString自定义会话 ID。
platformSessionIdString平台会话 ID。
customTaskIdString自定义任务 ID。
platformTaskIdString平台任务 ID。
eventDetailObject[EventDetail]事件详情。
errorMessageObject[EventDetail]错误详情。
当启动失败时,返回该参数。
tagsMap<String,String>会话标签。

EventDetail 数据结构如下所示。

名称类型是否必选说明
appIdString应用 ID。
appVersionString应用版本 ID。
appBizConfigString平台适配时自定义的业务配置数据。
streamingTokenString串流鉴权信息,存在串流服务时才会携带。
endpointObject[Endpoint]事件详情。
当启动成功时,返回该参数。

Endpoint 数据结构如下所示。

名称类型是否必选说明
nameString名称。
typeString类型。
accessHostString终端节点 IP 地址。
accessPortString终端节点端口。
ispString运营商标识。
取值:
MOBILE:中国移动。
UNICOM:中国联通。
TELECOM:中国电信。
BGP:多线网络。
districtIdString区域 ID。
regionIdString地域 ID。

ErrorMessage 数据结构如下所示。

名称类型是否必选说明
codeString错误码。
msgString错误详情。
  • 含有串流的业务创建会话成功后,事件类型为APP_STREAMING_INIT。串流初始化信息通过以下消息通知。
    注意 仅限 API 对接模式,不适用于 H5 SDK 对接模式。
名称类型是否必选说明
successBoolean串流初始化是否成功。
取值:
true:初始化成功。
false:初始化失败。
eventTypeString事件类型。
customSessionIdString自定义会话 ID。
platformSessionIdString平台会话 ID。
customTaskIdString自定义任务 ID。
platformTaskIdString平台任务 ID。
eventDetailObject[EventDetail]事件详情。

EventDetail 数据结构如下所示。

名称类型是否必选说明
appIdString应用 ID。
appVersionString应用版本 ID。
appBizConfigString平台适配时自定义的业务配置数据。
streamingTokenString串流鉴权信息,存在串流服务时才会携带。
eventDetailObject[EventDetail]事件详情。
当会话启动成功时,返回该参数。
errorMessageObject错误详情.
当会话启动失败时,返回该参数。

Endpoint 数据结构如下所示。

名称类型是否必选说明
nameString名称。
typeString类型。
accessHostString终端节点 IP 地址。
accessPortString终端节点端口。
ispString
运营商标识。
取值:
MOBILE:中国移动。
UNICOM:中国联通。
TELECOM:中国电信。
BGP:多线网络。
districtIdString区域 ID。
regionIdString地域 ID。

ErrorMessage 数据结构如下所示。

名称类型是否必选说明
codeString错误码。
msgString错误详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AppIdstring

应用 ID。

13027XXXX
AppVersionstring

应用版本 ID。

说明 当您未指定生效版本时,默认应用最新版本。
35067XXXX
CustomUserIdstring

自定义用户 ID,最大长度不超过 64 个字符。

用于业务对用户维度做相应的操作。

说明 当应用类型为end_gamehand_game时,本参数必填。
2YEF0XXXX
CustomSessionIdstring

自定义会话 ID,保证请求幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。

说明 支持 ASCII 字符,且不能超过 64 个字符。
1ADE0XXXX
ClientIpstring

业务的客户端 IP,比如云游戏场景中玩家的 IP。

192.168.XXX.XXX
StartParametersarray<object>

启动参数。

object
Keystring

目前支持的枚举值包括:

  • startArgument:应用启动参数。
startArgument
Valuestring

key 对应的取值。

exampleValue
SystemInfoarray<object>

系统信息,如客户端侧机型等信息。

object
Keystring

key 取值支持自定义。约定以下保留字:

  • utdid:表示设备 ID,可以帮助平台分析异常流量的特征和定位问题
utdid
Valuestring

key 对应的取值。

OE0usD+APXXXX
Timeoutlong

按量付费模式按需生产资源的超时时间。 取值范围 [900, 43200]秒,默认值 1800。

1800
EnablePostpaidboolean

按量付费模式下创建会话时,是否按需生产资源。取值范围:

  • true:是
  • false:否,默认 false
false
ProjectIdstring

项目 ID。如果已将应用关联到项目,创建会话时需填写正确的项目 ID。

d9a8****
AdapterFileIdstring

适配文件 ID。此功能灰度开放,如未约定使用请勿传入。

501716211209548966XXXX
DistrictIdstring

区域 ID。取值:

  • huadong

  • xinan

  • huanan

  • huabei

  • huazhong

huadong

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

46329898-489C-4E63-9BA1-C1DA5C5D0986
CustomSessionIdstring

自定义会话 ID。

1ADE0XXXX
PlatformSessionIdstring

平台会话 ID。

100XXXX
AppIdstring

应用 ID。

13027XXXX
AppVersionstring

应用版本 ID。

35067XXXX

示例

正常返回示例

JSON格式

{
  "RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986",
  "CustomSessionId": "1ADE0XXXX",
  "PlatformSessionId": "100XXXX",
  "AppId": "13027XXXX",
  "AppVersion": "35067XXXX"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-05-20API 内部配置变更,不影响调用查看变更详情
2022-03-03新增 OpenAPI查看变更详情