功能描述
用于创建配额。
说明:
要求权限:admin。有关权限详情请参见 生成访问令牌接口。
当在配置了配额的租户空间中上传即将超过配额的文件时,会返回 QuotaLimitReached 错误码。
租户空间的剩余空间非实时更新,当系统负荷较高时可能会有比较大的更新延时,进而可能导致意外超出配额,如果配置了超额自动删除选项,可能进一步导致旧文件被删除。
请求
请求示例
POST /api/v1/quota/{
LibraryId
}
?access_token={
AccessToken
}
&user_id={
UserId
}
请求参数:
请求体
application/json,指定租户空间(仅多租户空间媒体库)和配额值。
请求体示例:
{"spaces": [ "space111", "space222" ],"capacity": "1099511627776","removeWhenExceed": true,"removeAfterDays": 30,"removeNewest": false}
请求体字段说明:
请求参数 | 描述 | 类型 | 是否必选 |
spaces | 对于多租户空间媒体库,指定配额所涵盖的租户空间,以便同时控制多个租户空间的配额,不支持传空数组;对于单租户空间,不能指定该字段 | Array | 否 |
capacity | 配额的具体值,单位为字节(Byte),可以指定为数字形式或字符串形式,为了避免大数产生的精度损失,建议该字段指定为字符串形式 | String | 否 |
removeWhenExceed | 当指定为 false 时,配额仅用于上传时判断是否有足够空间,对于已经超限的空间不执行任何删除清理操作; 当指定为 true 时,创建配额将检查当前存储量,如果存储量已经超限,那么将在 removeAfterDays 天数到达后开始删除文件以保证存储量在配额之下,默认删除最早的文件,如果 removeNewest 指定为 true 则删除最新的文件,必选参数 | Boolean | 否 |
removeAfterDays | 存储量超限后在进行文件删除前等待的天数 | Int | 是 |
removeNewest | 是否从最新的文件开始删除,默认为 false,即从最旧的文件开始删除 | Boolean | 否 |
响应
响应码
创建成功,返回 HTTP 201 Created。
响应体
application/json
响应体示例:
{ "quotaId": 1 }
响应体字段说明:
响应参数 | 描述 | 类型 |
quotaId | 配额 ID,用于后续查询配额的具体信息、修改配额值或删除配额 | Int |