释放预定的容器。当符合指定条件且多个条件同时满足时,容器才会被释放。释放结果通过HTTP接口返回。
接口说明
释放预定容器的操作具有原子性,不存在部分成功或部分失败的情况。
当释放任务成功时,HTTP 接口消息通知如下:
说明
HTTP 接口是接收会话启动、停止、串流等信息的一种方式。目前消息保存 1 天,重试策略为退避策略,最多重试 176 次。
事件类型为RELEASE_CAPACITY_RESULT
。
注意 不区分模式,仅推送 HTTP 接口。
名称 | 类型 | 是否必选 | 说明 |
---|---|---|---|
success | Boolean | 是 | 任务是否成功。 取值: true:任务成功。 false:任务失败。 |
eventType | String | 是 | 事件类型。 |
eventDetail | Object[EventDetail] | 是 | 事件详情。 当任务成功时,返回该参数。 |
EventDetail 数据结构如下所示。
名称 | 类型 | 是否必选 | 说明 |
---|---|---|---|
taskId | String | 是 | 容器异步释放任务 ID。 |
success | Boolean | 是 | 释放是否成功。 取值: true:释放成功。 false:释放失败。 |
expectReleaseSessionCapacity | Integer | 是 | 期望释放的会话路数。 |
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectId | string | 是 | 项目 ID。 | d9a8**** |
AppId | string | 是 | 应用 ID。 | 13027**** |
DistrictId | string | 是 | 区域 ID。取值:
| huadong |
ExpectReleaseSessionCapacity | integer | 是 | 期望释放的会话路数。 | 100 |
AppVersion | string | 否 | 版本 ID。 | 35067**** |
返回参数
示例
正常返回示例
JSON
格式
{
"TaskId": "b354****",
"RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986"
}
错误码
访问错误中心查看更多错误码。