简要描述
请求URL
{{adminHost:8181}}/appli/addPackage
请求方式
| 字段名 |
示例值 |
必选 |
类型 |
说明 |
| adminKey |
603284317954637824 |
是 |
string |
该参数为后台管理接入凭证，在LarkXR3.3后台接入管理中查看 |
| timestamp |
8641706679604867 |
是 |
string |
发送请求时的时间戳，单位为毫秒 |
| signature |
9A02B47AE67664D80A2ED13FC2B1691512613790 |
是 |
string |
该参数为密钥签名。将adminKey（LarkXR3.2后台接入管理中查看）和adminSecret（LarkXR3.3后台中接入管理查看）和当前时间戳（long型数值）按字母序排序，然后进行SHA-1摘要签名。请参考【获取凭证签名】的样例 |
请求Body参数
| 参数名 |
示例值 |
必选 |
类型 |
说明 |
| pkgName |
testPackage |
是 |
string |
程序包名称 |
| pkgId |
|
否 |
string |
程序包Id，作用于同一个程序包ID有不同的版本号、供应用管理中的应用去选择 |
| version |
|
是 |
string |
必填项：程序包版本号 |
| wsId |
|
否 |
string |
工作区 |
| zipFile |
|
否 |
string |
应用包路径，如果使用上传程序包的方式就必须传zipFile参数，如果使用在服务器上安装的应用那么可以不传递程序包（对应应用上传接口返回值zipFilePath） |
| appliPath |
|
否 |
string |
应用程序包保存的子目录（对应应用上传接口返回值appliPath） |
| fileSize |
|
否 |
string |
应用程序包大小（对应应用上传接口返回值fileSize） |
| exeFileName |
1.exe |
是 |
string |
应用的启动文件路径，压缩包内相对路径（对应应用上传接口返回值exeFileName） |
| exeFileNameList |
|
否 |
string |
执行文件可选列表（对应应用上传接口返回值exeFileNameList） |
| param |
|
否 |
string |
应用启动的命令行参数，默认空 |
| initiativeSyncFlag |
|
否 |
string |
主动同步标识，默认为1； 0：不主动同步、1：主动同步、2：半主动同步 |
| syncRegions |
|
否 |
string |
半主动同步时（initiativeSyncFlag 传递 2）的同步区域，当为空时表示所有区域。区域Id以逗号分割 |
| syncCoefficient |
|
否 |
string |
半主动同步时的同步系数，默认为1，表示一个区域只选择一个节点同步一个应用 |
成功返回示例
{
"code": 1000,
"message": "保存成功",
"result": {
"pgmId": "1224416183051091968",
"wsId": "Jx3wQMD1",
"initiativeSyncFlag": 1,
"pkgId": "100225",
"version": "1.0.0",
"pkgName": "testPackage",
"appliPath": "",
"zipFile": "",
"exeFileName": "1.exe",
"exeFileNameList": "",
"param": "",
"createDate": "1711965166592",
"updateDate": "1711965166593"
}
}
成功返回示例的参数说明
| 参数名 |
类型 |
说明 |
| code |
string |
响应码 |
| message |
string |
响应消息 |
| result |
object |
响应结果 |
| pgmId |
string |
项目Id |
| wsId |
string |
工作空间Id |
| initiativeSyncFlag |
int |
主动同步标识， 0：不主动同步、1：主动同步、2：半主动同步 |
| pkgId |
string |
程序包Id |
| version |
string |
程序包版本号 |
| pkgName |
string |
程序包名称 |
| appliPath |
string |
应用程序的保存路径 |
| zipFile |
string |
zip包存储路径 |
| exeFileName |
string |
应用的执行文件路径 |
| exeFileNameList |
array |
应用的exe列表 |
| param |
string |
应用程序启动的命令行参数 |
| createDate |
long |
创建时间 |
| updateDate |
long |
更新时间 |
失败返回示例
{
"code": 500,
"message": "exeFileName不能为空"
}
失败返回示例的参数说明
| 参数名 |
类型 |
说明 |
| code |
string |
无 |
| message |
string |
无 |
备注
