简要描述
请求URL
{{adminHost:8181}}/appli/search
请求方式
| 字段名 |
示例值 |
必选 |
类型 |
说明 |
| adminKey |
603284317954637824 |
是 |
string |
该参数为后台管理接入凭证，在LarkXR3.3后台接入管理中查看 |
| timestamp |
8641706679604867 |
是 |
string |
发送请求时的时间戳，单位为毫秒 |
| signature |
9A02B47AE67664D80A2ED13FC2B1691512613790 |
是 |
string |
该参数为密钥签名。将adminKey（LarkXR3.2后台接入管理中查看）和adminSecret（LarkXR3.3后台中接入管理查看）和当前时间戳（long型数值）按字母序排序，然后进行SHA-1摘要签名。请参考【获取凭证签名】的样例 |
请求Query参数
| 参数名 |
示例值 |
必选 |
类型 |
说明 |
| appliId |
|
否 |
string |
应用id |
| appliName |
|
否 |
string |
应用名称 |
| wsId |
|
否 |
string |
工作空间id |
| page |
|
否 |
string |
页码，默认是1 |
| pageSize |
|
否 |
string |
每页展示多少条数据，默认20 |
成功返回示例
{
"code": 1000,
"message": "Success",
"result": {
"records": [
{
"appliId": "1213068656913678336",
"appliName": "test",
"appliType": 2,
"accessType": 1,
"wsId": "Jx3wQMD1",
"picUrl": "",
"pgmId": "1212814918814793728",
"pkgId": "100178",
"version": "1",
"fileSize": "16517216",
"appliPath": "",
"exeFileName": "nginx/nginx.exe",
"exeFileNameList": "",
"param": "",
"status": 1,
"instanceMax": 1,
"hasExtraParam": 0,
"initWinSize": 0,
"initResolutionType": 0,
"frameLowerLimit": 30,
"initiativeSyncFlag": 1,
"initCursorMode": 0,
"offScreen": 1,
"fullScreenMode": 0,
"mobileFullScreenMode": 0,
"startProcType": 0,
"useGamepad": 0,
"mobileForceLandscape": 1,
"mobileVirtualJoystick": 1,
"mobileKeyboardType": 0,
"mobileWebMenuType": 1,
"mouseZoomDirection": 1,
"playerListToggle": 1,
"limitMaxFps": 1,
"touchOperateMode": "mouse",
"arAlphaMask": 0,
"dcs": 1,
"playMode": 1,
"scs": 0,
"audioInput": 0,
"audioInputAutoStart": 0,
"videoInput": 0,
"videoInputAutoStart": 0,
"videoInputCnt": 1,
"liveStreaming": 0,
"textInputEventPrompt": 1,
"vrControllerType": 0,
"qpMin": 20,
"qpMax": 35,
"taskCloseType": 0,
"delayCloseDuration": 20,
"reqGpuMemMax": 0,
"useWebCodec": 0,
"preferDecoder": "h264",
"createUser": "443167382534356992",
"createDate": "1709259705534",
"updateUser": "443167382534356992",
"updateDate": "1711070638914",
"deleteFlag": 0
},
{
"appliId": "1217109955904012288",
"appliName": "zsnn",
"appliType": 2,
"accessType": 0,
"wsId": "Jx3wQMD1",
"pgmId": "1217058508743114752",
"pkgId": "100203",
"version": "0.0.1",
"zipFile": "1217058375657848832.zip",
"fileSize": "21484303",
"appliPath": "20240312103528799",
"exeFileName": "LarkDataChannelDemo.exe",
"exeFileNameList": "",
"param": "",
"status": 1,
"instanceMax": 1,
"hasExtraParam": 0,
"initWinSize": 0,
"initResolutionType": 0,
"frameLowerLimit": 30,
"initiativeSyncFlag": 1,
"initCursorMode": 0,
"offScreen": 1,
"fullScreenMode": 0,
"mobileFullScreenMode": 0,
"startProcType": 0,
"useGamepad": 0,
"mobileForceLandscape": 1,
"mobileVirtualJoystick": 1,
"mobileKeyboardType": 0,
"mobileWebMenuType": 0,
"mouseZoomDirection": 1,
"playerListToggle": 1,
"limitMaxFps": 1,
"touchOperateMode": "mouse",
"arAlphaMask": 0,
"dcs": 1,
"playMode": 1,
"scs": 0,
"audioInput": 0,
"audioInputAutoStart": 0,
"videoInput": 0,
"videoInputAutoStart": 0,
"videoInputCnt": 1,
"liveStreaming": 0,
"textInputEventPrompt": 1,
"vrControllerType": 0,
"qpMin": 20,
"qpMax": 35,
"taskCloseType": 0,
"delayCloseDuration": 20,
"reqGpuMemMax": 0,
"useWebCodec": 0,
"preferDecoder": "h264",
"createUser": "443167382534356992",
"createDate": "1710223226297",
"updateUser": "443167382534356992",
"updateDate": "1710839602915",
"deleteFlag": 0
},
{
"appliId": "1217122516187742208",
"appliName": "test",
"appliType": 2,
"accessType": 1,
"wsId": "yzpVmS4A",
"pgmId": "1217122515504070656",
"pkgId": "100212",
"version": "1.0.0",
"zipFile": "1217121905081843712.zip",
"fileSize": "262223764",
"appliPath": "20240312144755383",
"exeFileName": "Dismantle.exe",
"exeFileNameList": "Dismantle.exe",
"param": "",
"status": 1,
"instanceMax": 9999,
"hasExtraParam": 0,
"initWinSize": 0,
"initResolutionType": 1,
"frameLowerLimit": 30,
"initiativeSyncFlag": 1,
"initCursorMode": 0,
"offScreen": 1,
"fullScreenMode": 0,
"mobileFullScreenMode": 0,
"startProcType": 0,
"useGamepad": 0,
"mobileForceLandscape": 1,
"mobileVirtualJoystick": 1,
"mobileKeyboardType": 0,
"mobileWebMenuType": 0,
"mouseZoomDirection": 1,
"playerListToggle": 1,
"limitMaxFps": 1,
"touchOperateMode": "mouse",
"dcs": 0,
"playMode": 0,
"scs": 0,
"audioInput": 0,
"audioInputAutoStart": 0,
"videoInput": 0,
"videoInputAutoStart": 0,
"videoInputCnt": 1,
"liveStreaming": 0,
"textInputEventPrompt": 1,
"vrControllerType": 0,
"qpMin": 20,
"qpMax": 35,
"taskCloseType": 0,
"delayCloseDuration": 20,
"reqGpuMemMax": 0,
"useWebCodec": 0,
"preferDecoder": "h264",
"createDate": "1710226220902",
"updateDate": "1710226220902",
"deleteFlag": 0
},
{
"appliId": "1217761300466106368",
"appliName": "test",
"appliType": 2,
"accessType": 1,
"wsId": "LkZHF4EC",
"pgmId": "1217761299853737984",
"pkgId": "100213",
"version": "1.0.0",
"zipFile": "1217760376465129472.zip",
"fileSize": "262223764",
"appliPath": "20240314090458892",
"exeFileName": "Dismantle.exe",
"exeFileNameList": "Dismantle.exe",
"param": "",
"status": 1,
"instanceMax": 9999,
"hasExtraParam": 0,
"initWinSize": 0,
"initResolutionType": 1,
"frameLowerLimit": 30,
"initiativeSyncFlag": 1,
"initCursorMode": 0,
"offScreen": 1,
"fullScreenMode": 0,
"mobileFullScreenMode": 0,
"startProcType": 0,
"useGamepad": 0,
"mobileForceLandscape": 1,
"mobileVirtualJoystick": 1,
"mobileKeyboardType": 0,
"mobileWebMenuType": 0,
"mouseZoomDirection": 1,
"playerListToggle": 1,
"limitMaxFps": 1,
"touchOperateMode": "mouse",
"dcs": 1,
"playMode": 1,
"scs": 0,
"audioInput": 0,
"audioInputAutoStart": 0,
"videoInput": 0,
"videoInputAutoStart": 0,
"videoInputCnt": 1,
"liveStreaming": 0,
"textInputEventPrompt": 1,
"vrControllerType": 0,
"qpMin": 20,
"qpMax": 35,
"taskCloseType": 0,
"delayCloseDuration": 20,
"reqGpuMemMax": 0,
"useWebCodec": 0,
"preferDecoder": "h264",
"createDate": "1710378518942",
"updateDate": "1710378518942",
"deleteFlag": 0
}
],
"total": "4",
"size": "15",
"current": "1",
"orders": [],
"optimizeCountSql": true,
"searchCount": true,
"pages": "1"
}
}
成功返回示例的参数说明
| 参数名 |
类型 |
说明 |
| code |
string |
响应码 |
| message |
string |
响应消息 |
| result |
object |
响应结果 |
| records |
array |
结果列表 |
| records.appliId |
long |
应用Id |
| records.appliName |
string |
应用名称 |
| records.appliType |
int |
应用类型： 1：独占GPU、2：共享GPU、3：VR(SteamVR)、5：VR(SteamVR:依赖Steam)、6：VR(Nvidia)、7：VR(OpenXR)、9：AR(PXY)、11：AR(Nvidia)、13：SR(共享GPU-UE像素流送)】 、14：SR（2D共享）) |
| records.accessType |
int |
1：公开应用、 0：私有应用 |
| records.wsId |
string |
工作空间Id |
| records.picUrl |
string |
应用背景图 |
| records.pgmId |
string |
程序包项目Id |
| records.pkgId |
string |
程序包Id |
| records.version |
string |
程序包版本 |
| records.fileSize |
int |
应用大小 |
| records.appliPath |
string |
应用程序的保存路径 |
| records.exeFileName |
string |
应用的执行文件路径 |
| records.exeFileNameList |
array |
应用的exe列表 |
| records.param |
string |
应用程序启动的命令行参数 |
| records.status |
int |
1：上架 0：下架 |
| records.instanceMax |
int |
该应用最大允许客户端并发数 |
| records.hasExtraParam |
int |
应用启动的命令行参数是否传递TaskId， 0（否）、1（是） |
| records.initWinSize |
int |
窗口填充方式 ， 0：按原始窗口大小显示（不超过终端屏幕）、5：按应用原始窗口显示（超过终端屏幕出现滚动条）、2：尽量填充容器（保存宽高比，不超过终端屏幕）、10：优先垂直方向填充（保持宽高比，水平方向允许出现滚动条）、15：优先垂直方向填充（保持宽高比，垂直方向允许出现滚动条）、4：完全填充容器（拉伸） |
| records.initResolutionType |
int |
初始化分辨率方式， 0：应用默认分辨率、 1：适应客户端窗口 |
| records.frameLowerLimit |
int |
最低帧率，默认30：每秒30帧 |
| records.initiativeSyncFlag |
int |
主动同步标识， 0：不主动同步、1：主动同步、2：半主动同步 |
| records.initCursorMode |
int |
鼠标模式， 0：自动判断、1：锁定、2：非锁定 |
| records.offScreen |
int |
是否离屏渲染，离屏渲染时能减少部分资源消耗，默认是1。 0：不是。1：是 |
| records.fullScreenMode |
int |
全屏模式（效果等同F11键），默认是0； 0：手动触发，按下F11键盘或者是左下角的全屏按钮。 1：首次点击屏幕使用的时候触发 2：每次点击屏幕的时候触发。 |
| records.mobileFullScreenMode |
int |
手机端全屏模式，默认是0； 0：手动触发 1：首次点击屏幕使用的时候触发 2：每次点击屏幕的时候触发。 |
| records.startProcType |
int |
独占模式下启动模式，大部分为标准模式：0，少部分为兼容模式：1 |
| records.useGamepad |
int |
该应用是否使用手柄，默认为0；0：不使用，1：使用 |
| records.mobileForceLandscape |
int |
手机端时是否强制横屏，默认为1；0：否，1：是 |
| records.mobileVirtualJoystick |
int |
手机端是否初始显示虚拟摇杆，默认为1；0：否，1：是 |
| records.mobileKeyboardType |
int |
移动端输入键盘类型 ，0:默认系统键盘，1:虚拟键盘 |
| records.mobileWebMenuType |
int |
移动端菜单类型， 0：控制球、 1：菜单栏 |
| records.mouseZoomDirection |
int |
触屏放大手势与滚轮映射，默认为1；0：滚轮下滚，1：滚轮上滚 |
| records.playerListToggle |
int |
演示/互动模式是否显示玩家列表，默认为1；0：否，1：是 |
| records.limitMaxFps |
int |
在共享模式下是否限制应用本身的帧率，默认为1；0：否，1：是 |
| records.touchOperateMode |
string |
移动端的触摸指令模式，mouse：鼠标，touch：触摸，touch时，客户端的触摸指令直接以windows的原生触摸指令发送给渲染服务器，mix：混合模式，鼠标和触摸事件一起发送 |
| records.arAlphaMask |
int |
AR应用是否使用了透明遮罩的默认值为1，0：关闭，1：开启 |
| records.dcs |
int |
应用级别是否支持数据通道服务，1支持，0不支持 |
| records.playMode |
int |
应用级别是否支持互动模式，1支持，0不支持 |
| records.scs |
int |
应用是否使用智能语音服务，1使用，0不使用 |
| records.audioInput |
int |
是否开启客户端音频（麦克风）输入功能，1开启，0不开启 |
| records.audioInputAutoStart |
int |
是否自动开启麦克风，1开启，0不开启 |
| records.videoInput |
int |
是否开启客户端视频（摄像头）输入功能，1开启，0不开启 |
| records.videoInputAutoStart |
int |
是否自动开启摄像头 |
| records.videoInputCnt |
int |
应用使用的摄像头数量 |
| records.liveStreaming |
int |
是否开启直播推流，1开启，0不开启 |
| records.textInputEventPrompt |
int |
是否启用客户端文字输入事件提示，1开启，0不开启 |
| records.vrControllerType |
int |
VR手柄类型：0:默认,1:Quest,2:HTC,3:Pico,4:Nolo |
| records.qpMin |
int |
编码qp最小值 |
| records.qpMax |
int |
编码qp最大值 |
| records.taskCloseType |
int |
实例关闭方式：0即时关闭(默认)、1延迟关闭 |
| records.delayCloseDuration |
int |
延迟关闭的延迟时间，单位秒，默认20秒 |
| records.reqGpuMemMax |
int |
最大GPU显存需求量（单位M）,用于分配请求时检查显存是否充足，默认值0：不考虑当前应用显存需求，只检查当前GPU显存使用量 |
| records.useWebCodec |
int |
是否使用WebCodec，0：不使用、1：使用 |
| records.preferDecoder |
string |
优先使用的解码格式标准：’auto’ 、’vp8’ 、 ‘vp9’ 、 ‘h264’ 、 ‘h265’ 、’hevc’ 、’av1’ 、’av1x’,默认值h264 |
| records.createUser |
long |
创建的用户id |
| records.createDate |
long |
创建时间 |
| records.updateUser |
long |
更新的用户id |
| records.updateDate |
long |
更新时间 |
| records.deleteFlag |
string |
删除标识，0：未删除、1已删除 |
| total |
string |
共计多少条数据 |
| size |
string |
每页多少条数据 |
| current |
string |
当前页码 |
| orders |
array |
无 |
| optimizeCountSql |
string |
无 |
| searchCount |
string |
无 |
| pages |
string |
一共有多少页 |
备注
