1. 升版/替换模型文件
升版或替换模型文件。
请求方式:POST
请求地址:/api/{databaseKey}/files/update
1.1. 请求参数
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | 操作的通关令牌 |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
databaseKey | string | test | 是 | 数据库key,必传 |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
无参数 | NULL | NULL | NULL | NULL |
Body
application/json:
{
"fileKey": "XXX", //待升版或替换的文件key,必传
"file": "XXX", //本地文件 或者
"url": "XXX", //网络下载地址
"revision": true //是否升版,true或false
}
1.2. 参数说明
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
fileKey | string | xxxxxxxxxx | 是 | 待升版或替换的文件key |
file | file | 无 | 是 | 本地文件 |
url | string | www.xxxxxx.com | 否 | 网络下载地址 |
revision | boolean | true/false | 是 | 是否升版 |
1.3. 正确返回
{
"code": "SUCCESS",
"message": "请求处理成功",
"data": {
"key": "XXX",
"version": "XXX", //当前最新版本
"modelKey": "XXX" //如有
}
}
1.4. 状态码
状态码 | code | message | data | 原因 |
---|---|---|---|---|
400 | PARAMETER | file、url不可同时为空 | NULL | 当file、url均未指定时 |
400 | BAD_PARAMETER | file、url不可同时指定 | NULL | 当file、url同时指定时 |
400 | BAD_PARAMETER | 无法确定类型 | NULL | 当file不是系统支持的模型文件时 |
400 | BAD_PARAMETER_VALUE | 参数(url)值不正确 | NULL | 当url不是有效网址时 |
400 | BAD_PARAMETER_VALUE | url(xxx)无效,无法下载文件 | NULL | 当url无法下载文件时 |
400 | BAD_PARAMETER | 模型类型与原模型不一致 | NULL | 新版文件的模型类型与原模型不一致时 |
400 | BIZ_EXCEPTION | 数据库创建者的存储空间已达限额 | NULL | 当文件总量已超数据库创建者的存储空间限额时 |
1.5. 备注
文件升版/替换完成后,需要执行以下后续操作:
如原模型已有modelKey,需调用'重新解析指定key的模型文件'接口重新解析模型;否则需调用'解析指定key的模型文件'接口解析模型文件。
模型解析成功后,需调用'更新场景'接口更新场景。
## 注意事项
1、替换(revision为false)时,替换原模型文件,清空原模型数据,fileKey和modelKey保持不变。
2、升版(revision为true)时,保留原模型文件和模型数据为历史版本(可通过*key-version*获取历史信息,初始version为0),最新版本fileKey和modelKey保持不变。
3、file、url只能选择其一。
4、revision可选,值为true或false默认值为true。
5、根据上传内容自动判断模型类型,升版时模型类型必须与原模型类型一致;
6、如果数据库创建者的存储空间有限制,则需检查数据库创建者所建的所有数据库的模型文件总量是否超过限额。校验规则:待上传文件增量+数据库创建者创建的所有库中的模型文件大小大于等于数据库创建者存储容量。