创建容器预定任务。预定可运行指定会话数量的容器,预定结果通过HTTP接口返回。
接口说明
当预定任务完成时,HTTP 接口推送消息如下:
说明
HTTP 接口是接收会话启动、停止、串流等消息的一种方式。目前消息保存 1 天,重试策略为退避重试,最多重试 176 次。
事件类型为CAPACITY_REEERVATION_RESULT
。
注意 不区分模式,仅推送 HTTP 接口。
名称 | 类型 | 是否必选 | 说明 |
---|---|---|---|
success | Boolean | 是 | 任务是否成功。 取值: true:任务成功。 false:任务失败。 |
eventType | String | 是 | 事件类型。 |
eventDetail | Object[EventDetail] | 是 | 事件详情。 当任务成功时,返回该参数。 |
EventDetail 数据结构如下所示。
名称 | 类型 | 是否必选 | 说明 |
---|---|---|---|
taskId | String | 是 | 任务 ID。 |
success | Boolean | 是 | 任务是否成功。 取值: true:任务成功。 false:任务失败。 |
projectId | String | 是 | 项目 ID。 |
appId | String | 是 | 应用 ID。 |
appVersion | String | 是 | 应用版本。 |
districtId | String | 是 | 区域 ID。 |
expectSessionCapacity | Integer | 是 | 期望支撑的会话数量。 |
realSessionCapacity | Integer | 是 | 实际生产出的容器能支撑的会话数量。 |
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectId | string | 是 | 项目 ID。 | d9a8**** |
AppId | string | 是 | 应用 ID。 | 13027**** |
AppVersion | string | 否 | 应用版本 ID。 | 35067**** |
DistrictId | string | 是 | 区域 ID。取值:
| huadong |
ExpectResourceReadyTimedeprecated | string | 否 | 预期资源开始服务时间。 时间格式: 时区是北京时间(东八区)。 说明
本参数仅适用于白名单用户。
| 2022-02-02 22:22:22 |
ExpectSessionCapacity | integer | 是 | 预期可支持的会话数量。 | 100 |
ClientToken | string | 否 | 自定义 Token,保证请求幂等性。 说明
支持 ASCII 字符,且不能超过 64 个字符。
| 2YEF0**** |
返回参数
示例
正常返回示例
JSON
格式
{
"TaskId": "b354****",
"CurrMaxAllocatableSessionCapacity": 10000,
"RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-05-20 | API 内部配置变更,不影响调用 | 查看变更详情 |