备案控制台
文档
产品文档
输入文档关键字查找
首页 云渲染 开发参考 API参考 API目录 会话管理 CreateAppSessionSync - 同步创建应用会话

CreateAppSessionSync - 同步创建应用会话

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

创建应用会话并启动应用进程后，会话信息通过消息返回。

接口说明

  • 创建会话成功后，事件类型为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。

13027****
AppVersionstring否

应用版本 ID。

35067****
CustomUserIdstring否

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

说明 当应用类型为end_game、hand_game时，本参数必填。
2YEF0****
CustomSessionIdstring是

自定义会话 ID。

说明 支持 ASCII 字符，且不能超过 64 个字符。
1ADE0****
ClientIpstring否

业务的客户端 IP 地址。

192.168.XX.XX
StartParametersobject []否

业务定制参数。

Keystring否

目前支持的枚举值。取值为 startArgument，表示应用启动参数。

startArgument
Valuestring否

Key 对应的取值。

exampleValue
SystemInfoobject []否

系统信息。

Keystring否

目前支持自定义。取值为 utdid，表示设备 ID。可以帮助平台分析异常流量的特征和定位问题。

utdid
Valuestring否

Key 对应的取值。

OE0usD+AP****
Tagsobject []否

自定义标签。

Keystring否

标签键。最长 64 个字符。

exampleTag
Valuestring否

Key 对应的取值。

exampleValue
ProjectIdstring否

项目 ID。

d9a8****
DistrictIdstring否

区域 ID。取值：

  • huadong

  • xinan

  • huanan

  • huabei

  • huazhong

huadong
MatchRulesobject []否

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

Typestring否

规则类型。取值：

  • in：匹配携带指定 Key 和 Value 的资源。
  • notIn： 匹配不携带指定 Key 和 Value 的资源。
in
Keystring否

资源提供的标签名称。

取值：component，组件版本；指定组件版本时，只会用带有指定组件版本的资源启动会话。

component
Valuesarray否

需要匹配的标签值。

string否

约定的标签值。

exampleTag
AdapterFileIdstring否

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

501716211209548966XXXX

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

自定义会话 ID。

1ADE0****
PlatformSessionIdstring

平台会话 ID。

100****
AppIdstring

应用 ID。

13027****
AppVersionstring

应用版本 ID。

35067****
BizInfoobject

业务信息。

Bizobject

业务结果信息。

authToken
Endpointsobject []

终端节点信息。

Namestring

终端节点名称。

exampleName
AccessHoststring

终端节点 IP 地址。

127.0.X.X
AccessPortstring

终端节点端口。

8080
Typestring

终端节点类型。取值为 Native。

Native
DistrictIdstring

区域 ID。取值：

  • huadong

  • xinan

  • huanan

  • huabei

  • huazhong

huabei
Ispstring

运营商。取值：

  • MOBILE：中国移动。

  • UNICOM：中国联通。

  • TELECOM：中国电信。

  • BGP：多线网络。

BGP

示例

正常返回示例

JSON格式

{
  "RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986",
  "CustomSessionId": "1ADE0****",
  "PlatformSessionId": "100****",
  "AppId": "13027****",
  "AppVersion": "35067****",
  "BizInfo": {
    "Biz": {
      "test": "test",
      "test2": 1
    },
    "Endpoints": [
      {
        "Name": "exampleName",
        "AccessHost": "127.0.X.X",
        "AccessPort": "8080",
        "Type": "Native",
        "DistrictId": "huabei",
        "Isp": "BGP"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。
文档推荐
  • 本页导读 （0）
文档反馈