CreateAppSessionSync_云渲染_API文档

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