CreateAppSessionSync
创建应用会话并启动应用进程后,会话信息通过消息返回
服务地址:
华东1(杭州)
输入参数
只看必填
AppId应用ID
AppVersion应用版本ID
CustomUserId自定义用户ID
CustomSessionId自定义会话ID
ClientIp业务的客户端IP地址
StartParameters业务定制参数
0
Key目前支持的枚举值
ValueKey对应的取值
SystemInfo系统信息
0
Key目前支持自定义
ValueKey对应的取值
Tags自定义标签
0
Key标签键
ValueKey对应的取值
ProjectId项目ID
DistrictId区域ID
MatchRules资源匹配的规则信息
0
Type规则类型
Key资源提供的标签名称
Values需要匹配的标签值
0约定的标签值
AdapterFileId适配文件ID
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 创建会话成功后,事件类型为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错误详情。

请求参数

字段名称字段详情
AppIdstring

应用 ID。

示例值:13027****参考取值来源:
    ModifyApp
    ListApp
    CreateApp
    GetAppCcu
AppVersionstring

应用版本 ID。

示例值:35067****参考取值来源:
    ListAppVersion
    CreateAppVersion
    ModifyAppVersion
    GetAppSession
    StopAppSession
CustomUserIdstring

自定义用户 ID。用于存档的读取和保存。最大长度不超过 64 个字符。展开详情

示例值:2YEF0****字符长度 <= 64
CustomSessionIdstring

自定义会话 ID。展开详情

示例值:1ADE0****参考取值来源:
    StopAppSession
    ListAppSessions
    CreateAppSession
    GetAppSession
字符长度 <= 64
ClientIpstring

业务的客户端 IP 地址。

示例值:192.168.XX.XX
StartParametersarray<object>

业务定制参数。

SystemInfoarray<object>

系统信息。

Tagsarray<object>

自定义标签。

ProjectIdstring

项目 ID。

示例值:d9a8****
DistrictIdstring

区域 ID。取值:展开详情

示例值:huadong
MatchRulesarray<object>

资源匹配的规则信息,支持多个; 规则越多找到合适资源的耗时越长。

AdapterFileIdstring

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

示例值:501716211209548966XXXX

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:46329898-489C-4E63-9BA1-C1DA5C5D0986
CustomSessionIdstring

自定义会话 ID。

示例值:1ADE0****
PlatformSessionIdstring

平台会话 ID。

示例值:100****
AppIdstring

应用 ID。

示例值:13027****
AppVersionstring

应用版本 ID。

示例值:35067****
BizInfoobject

业务信息。

变更历史
暂无变更历史