批量停止应用会话。后续停止结果会通过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暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| BatchId | string | 是 | 批量操作 ID。 说明
支持 ASCII 字符，且不能超过 64 个字符。
| 6d4d**** |
| ProjectId | string | 否 | 项目 ID。 | d9a8**** |
| AppId | string | 否 | 应用 ID。 | 13027**** |
| AppVersion | string | 否 | 应用版本 ID。 | 35067**** |
| Tags | object [] | 否 | 自定义标签。 | |
| Key | string | 否 | 标签键。最长 64 个字符。 | exampleTag |
| Value | string | 否 | Key 对应的取值。 | exampleValue |
| StopParam | object [] | 否 | 停止容器参数。 | |
| Key | string | 否 | 目前支持的枚举值。取值为 reason ，表示停止原因。 | reason |
| Value | any | 否 | Key 对应的取值。 | exampleValue |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986",
"BatchId": "6d4d****",
"ProjectId": "d9a8****",
"AppId": "13027****"
}错误码
访问错误中心查看更多错误码。