找不到 API ? 点击 反馈吧
- 实例管理
- 应用管理
- 版本管理
- 适配管理
- 容器预定管理
- 会话管理
CreateAppSessionSync
创建应用会话并启动应用进程后,会话信息通过消息返回
服务地址:
华东1(杭州)
参数配置
高级配置
输入参数
只看必填
注意事项
AppId应用ID
AppVersion应用版本ID
CustomUserId自定义用户ID
CustomSessionId自定义会话ID
ClientIp业务的客户端IP地址
StartParameters业务定制参数
SystemInfo系统信息
Tags自定义标签
ProjectId项目ID
DistrictId区域ID
AdapterFileId适配文件ID
文档
调用结果
SDK 示例
CLI示例
相关示例
调用历史
错误码
流控
插件下载了解更多
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
接口说明
- 创建会话成功后,事件类型为
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 | 是 | 错误详情。 |
请求参数
字段名称 | 字段详情 |
---|---|
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 |
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 | 业务信息。 |
变更历史
暂无变更历史