批量停止应用会话。后续停止结果会通过HTTP接口返回。
接口说明
发起批量停止后，批量停止的进度会通过 HTTP 接口返回，直到在线数量为 0 或超时。
说明
HTTP 接口是接收会话启动、停止、串流等信息的一种方式。目前消息保存 1 天，重试策略为退避重试，最多重试 176 次。
事件类型为BATCH_STOP。
注意 不区分对接模式，仅推送 HTTP 接口。
| 名称 | 类型 | 是否必选 | 说明 |
|---|---|---|---|
| eventType | String | 是 | 事件类型。 |
| eventDetail | Object[EventDetail] | 是 | 事件详情， 当任务成功时，返回该参数。 |
EventDetail 数据结构如下所示。
| 名称 | 类型 | 是否必选 | 说明 |
|---|---|---|---|
| appId | String | 是 | 应用 ID。 |
| appVersion | String | 是 | 应用版本 ID。 |
| batchId | String | 是 | 批量 ID。 |
| projectId | String | 是 | 项目 ID。 |
| playersCount | Integer | 是 | 剩余在线数量。 |
| timestamp | String | 是 | 统计时间戳。 |
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cgcs:StopAppSessionBatch | update | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| BatchId | string | 是 | 批量操作 ID。 说明
支持 ASCII 字符，且不能超过 64 个字符。
| 6d4d**** |
| ProjectId | string | 否 | 项目 ID。 | d9a8**** |
| AppId | string | 否 | 应用 ID。 | 13027**** |
| AppVersion | string | 否 | 应用版本 ID。 | 35067**** |
| Tags | array<object> | 否 | 自定义标签。 | |
| object | 否 | |||
| Key | string | 否 | 标签键。最长 64 个字符。 | exampleTag |
| Value | string | 否 | Key 对应的取值。 | exampleValue |
| StopParam | array<object> | 否 | 停止容器参数。 | |
| object | 否 | |||
| Key | string | 否 | 目前支持的枚举值。取值为 reason ，表示停止原因。 | reason |
| Value | any | 否 | Key 对应的取值。 | exampleValue |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986",
"BatchId": "6d4d****",
"ProjectId": "d9a8****",
"AppId": "13027****"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史