文档

ReleaseCapacity - 释放预定的容器

更新时间:

释放预定的容器。当符合指定条件且多个条件同时满足时,容器才会被释放。释放结果通过HTTP接口返回。

接口说明

释放预定容器的操作具有原子性,不存在部分成功或部分失败的情况。

当释放任务成功时,HTTP 接口消息通知如下:

说明 HTTP 接口是接收会话启动、停止、串流等信息的一种方式。目前消息保存 1 天,重试策略为退避策略,最多重试 176 次。

事件类型为RELEASE_CAPACITY_RESULT

注意 不区分模式,仅推送 HTTP 接口。

名称类型是否必选说明
successBoolean任务是否成功。
取值:
true:任务成功。
false:任务失败。
eventTypeString事件类型。
eventDetailObject[EventDetail]事件详情。
当任务成功时,返回该参数。

EventDetail 数据结构如下所示。

名称类型是否必选说明
taskIdString容器异步释放任务 ID。
successBoolean释放是否成功。
取值:
true:释放成功。
false:释放失败。
expectReleaseSessionCapacityInteger期望释放的会话路数。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ProjectIdstring

项目 ID。

d9a8****
AppIdstring

应用 ID。

13027****
DistrictIdstring

区域 ID。取值:

  • huadong

  • xinan

  • huanan

  • huabei

  • huazhong

huadong
ExpectReleaseSessionCapacityinteger

期望释放的会话路数。

100
AppVersionstring

版本 ID。

35067****

返回参数

名称类型描述示例值
object

返回参数。

TaskIdstring

容器预定任务 ID。

b354****
RequestIdstring

请求 ID。

46329898-489C-4E63-9BA1-C1DA5C5D0986

示例

正常返回示例

JSON格式

{
  "TaskId": "b354****",
  "RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986"
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (0)
文档反馈