StopAppSession_云渲染_API文档

插件下载了解更多
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_STOP

注意 仅限 API 对接模式,不适用于 H5 SDK 对接模式。

名称类型是否必选说明
successBoolean停止是否成功。
取值:
true:停止成功。
false:停止失败。
eventTypeString事件类型。
customSessionIdString自定义会话 ID。
platformSessionIdString平台会话 ID。
normalBoolean是否正常停止。
取值:
true:正常停止。
false:异常停止。
eventDetailObject[EventDetail]事件详情,成功时返回。
errorMessageObject错误详情,失败时返回。

EventDetail 数据结构如下所示。

名称类型是否必选说明
appIdString应用 ID。
appVersionString应用版本 ID。

ErrorMessage 数据结构如下所示。

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
cgcs:StopAppSession
Update
全部资源
*

请求参数

字段名称字段详情
PlatformSessionIdstring

平台会话 ID,在平台中唯一标识一个会话。展开详情

示例值:100XXXX参考取值来源:
    CreateAppSession
    GetAppSession
    ListAppSessions
CustomSessionIdstring

自定义会话 ID。展开详情

示例值:1ADE0XXXX参考取值来源:
    ListAppSessions
    CreateAppSession
    GetAppSession
StopParamarray<object>

停止容器参数。此参数将透传到 Agent。

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

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

自定义会话 ID。

示例值:1ADE0XXXX
PlatformSessionIdstring

平台会话 ID 。

示例值:100XXXX
AppIdstring

应用 ID。

示例值:13027XXXX
AppVersionstring

应用版本 ID。

示例值:35067XXXX

返回示例

变更历史

变更时间变更内容概要操作
2022-03-03
新增OpenAPI,停止应用会话

相关示例