简要描述
请求URL
{{https://www.pingxingyun.com/console/api}}/poc/hostAppli/update
请求方式
字段名 |
示例值 |
必选 |
类型 |
说明 |
Key |
9FqNcCxA |
是 |
string |
调用开发者平台接口必传参数,在开发者平台后台,账号—安全设置—秘钥管理查看,平台秘钥Key |
timestamp |
8641724046238887 |
是 |
string |
当前时间戳,单位:毫秒 |
signature |
AD3B11BC135C39A7CA0058D8826ED74492F65142 |
是 |
string |
在开发者平台后台,账号—安全设置—秘钥管理查看Key&Secret:用于二次开发的接入凭证 【使用规则】 |
请求参数示例
{
"appliId": "1275123759124054016",
"userId": "1272883279040610304",
"appliName": "test5569",
"zipFile": "1275482972299984896.zip",
"appliPath": "20240820155358143",
"uploadId": "130AEAE0CC1D42EFA4EA55FF765887A6",
"exeFilePath": "LarkDataChannelDemo.exe",
"exeFilePathList": "LarkDataChannelDemo.exe,2.exe,3.exe",
"param": "",
"initWinSize": 0,
"initCursorMode": 0,
"fullScreenMode": 0,
"screenBgColor": "",
"startProcType": 0,
"useGamepad": 0,
"mobileForceLandscape": 1,
"mobileVirtualJoystick": 1,
"mouseZoomDirection": 1,
"playerListToggle": 1,
"limitMaxFps": 1,
"touchOperateMode": "mouse",
"syncRegions": "HDSH"
}
请求json字段说明
字段名 |
必选 |
类型 |
说明 |
appliId |
是 |
string |
应用Id |
appliName |
是 |
string |
应用名称 |
zipFile |
是 |
string |
如果更新了应用,设置为1.4分片上传接口返回的zipFilePath值,没有更新应用传原应用的zipFile |
appliPath |
是 |
string |
如果更新了应用,设置为1.4分片上传接口返回的appliPath值,没有更新应用传原应用的appliPath |
uploadId |
否 |
string |
如果更新了应用,必填。一个文件上传的整体标识,设置为1.3获取上传Id的uploadId的值 |
exeFilePath |
是 |
string |
选中的exeFilePathList列表中某个值 |
exeFilePathList |
是 |
string |
如果更新了应用,设置为1.4分片上传接口返回的exeFilePathList值,没有更新应用传原应用的exeFilePathList |
param |
否 |
string |
Unreal引擎开发的应用程序有可能需要启动参数, 可通过,本地直接运行->启动【任务管理器】->【详细信息】->鼠标置于状态栏, 右键【选择列】->勾选【命令行】,->然后找到正在运行的UE4 课程,查看命令行参数 |
initWinSize |
是 |
string |
初始化窗口方式 0:按照原始窗口大小显示 2:尽量填充容器(保存宽高比) 3:完全填充容器(裁剪) 4:完全填充容器(拉伸) 默认为0: 按照原始窗口大小显示 |
initCursorMode |
是 |
string |
鼠标模式,默认是0。0:非锁定模式。1:锁定模式 |
fullScreenMode |
是 |
string |
全屏模式(效果等同F11键),默认是0;0:手动触发,按下F11键盘或者是左下角的全屏按钮。1:首次点击屏幕使用的时候触发 2:每次点击屏幕的时候触发。 |
screenBgColor |
否 |
string |
web客户端的背景色,默认为空,即无背景色 |
startProcType |
是 |
string |
独占模式下启动模式,大部分为标准模式:0,少部分为兼容模式:1 |
useGamepad |
是 |
string |
该应用是否使用手柄,默认为0;0:不使用,1:使用 |
mobileForceLandscape |
是 |
string |
手机端时是否强制横屏,默认为1;0:否,1:是 |
mobileVirtualJoystick |
是 |
string |
手机端是否初始显示虚拟摇杆,默认为1;0:否,1:是 |
mouseZoomDirection |
是 |
string |
触屏放大手势与滚轮映射,默认为1;0:滚轮下滚,1:滚轮上滚 |
playerListToggle |
是 |
string |
互动模式是否显示玩家列表,默认为1;0:否,1:是 |
limitMaxFps |
是 |
string |
是否限制应用帧率,默认为1;0:否,1:是 |
touchOperateMode |
是 |
string |
移动端的触摸指令模式,mouse:鼠标,touch:触摸,touch时,客户端的触摸指令直接以windows的原生触摸指令发送给渲染服务器 |
syncRegions |
是 |
string |
应用所同步区域,根据1.5获取用户可选区域,设置多可用区的话,使用“ |
”拼接regionId,specifiedRegionList中的regionId必须传入。 |
成功返回示例
{
"code": 1000,
"message": "保存成功"
}
成功返回示例的参数说明
参数名 |
类型 |
说明 |
code |
int |
无 |
message |
string |
无 |
失败返回示例
{
"code":500
"message":"uploadId无效"
}
{
"code":500
"message":"请检查serviceItemList传值是否正确"
}
备注