文档

CreateCapacityReservation - 创建容器预定任务

更新时间:

创建容器预定任务。预定可运行指定会话数量的容器,预定结果通过HTTP接口返回。

接口说明

当预定任务完成时,HTTP 接口推送消息如下:

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

事件类型为CAPACITY_REEERVATION_RESULT

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

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

EventDetail 数据结构如下所示。

名称类型是否必选说明
taskIdString任务 ID。
successBoolean任务是否成功。
取值:
true:任务成功。
false:任务失败。
projectIdString项目 ID。
appIdString应用 ID。
appVersionString应用版本。
districtIdString区域 ID。
expectSessionCapacityInteger期望支撑的会话数量。
realSessionCapacityInteger实际生产出的容器能支撑的会话数量。

调试

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

授权信息

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

请求参数

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

项目 ID。

d9a8****
AppIdstring

应用 ID。

13027****
AppVersionstring

应用版本 ID。

35067****
DistrictIdstring

区域 ID。取值:

  • huadong

  • xinan

  • huanan

  • huabei

  • huazhong

huadong
ExpectResourceReadyTimedeprecatedstring

预期资源开始服务时间。

时间格式:yyyy-mm-dd HH:MM:SS

时区是北京时间(东八区)。

说明 本参数仅适用于白名单用户。
2022-02-02 22:22:22
ExpectSessionCapacityinteger

预期可支持的会话数量。

100
ClientTokenstring

自定义 Token,保证请求幂等性。

说明 支持 ASCII 字符,且不能超过 64 个字符。
2YEF0****

返回参数

名称类型描述示例值
object

返回参数。

TaskIdstring

容器预定任务 ID。

b354****
CurrMaxAllocatableSessionCapacityinteger

当前最大可分配的容器数量。

注意 当您重复调用本接口时,参数取值存在差异。

10000
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈