LarkXR3.3接口文档

获取运行应用一览

简要描述
  • 无
请求URL
  • {{adminHost:8181}}/taskInfo/getRunningAppliList
请求方式
  • get
Header
字段名 示例值 必选 类型 说明
adminKey 603284317954637824 是 string 该参数为后台管理接入凭证，在LarkXR3.3后台接入管理中查看
timestamp 8641706679604867 是 string 发送请求时的时间戳，单位为毫秒
signature 9A02B47AE67664D80A2ED13FC2B1691512613790 是 string 该参数为密钥签名。将adminKey（LarkXR3.3后台接入管理中查看）和adminSecret（LarkXR3.3后台中接入管理查看）和当前时间戳（long型数值）按字母序排序，然后进行SHA-1摘要签名。请参考【获取凭证签名】的样例
请求Query参数
参数名 示例值 必选 类型 说明
appliId   是 long 应用ID，不为空时返回特定应用的运行数量
appliType 14,2 是 array 应用类型,多个类型时，以逗号分割。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共享）)不为空时返回特定应用类型运行数量
serverId c255ced0be4451c5ba5524b926a53816 否 string 渲染节点ID,不为空时返回特定节点上运行数量
wsId Jx3wQMD 否 string 工作空间ID,不为空时返回特定工作空间上运行数量
taskId   否 long TaskId，若task运行结束，则返回为空
clientIp   否 string 客户端Ip,若该客户端离线，则返回为空
page   是 int 无
pageSize   是 int 无
成功返回示例
{
  "code": 1000,
  "message": "Success",
  "result": {
    "records": [
      {
        "taskId": "1202935225147981824",
        "status": 3,
        "startProcType": 0,
        "startAt": "1706843707148",
        "endAt": "0",
        "serverId": "c255ced0be4451c5ba5524b926a53816",
        "serverIp": "192.168.0.28",
        "publicIp": "",
        "clientIp": "192.168.0.28",
        "appliId": "1199762458126843904",
        "appliType": 2,
        "accessType": 1,
        "wsId": "Jx3wQMD1",
        "limitMaxFps": 1,
        "offScreen": 1,
        "useGamepad": 0,
        "dcs": 1,
        "playMode": 1,
        "scs": 0,
        "audioInput": 0,
        "audioInputAutoStart": 0,
        "videoInput": 0,
        "videoInputAutoStart": 0,
        "videoInputCnt": 1,
        "liveStreaming": 0,
        "qpMin": 20,
        "qpMax": 35,
        "taskCloseType": 0,
        "delayCloseDuration": 20,
        "reqGpuMemMax": 0,
        "useWebCodec": 0,
        "preferDecoder": "h264",
        "playerMode": 0,
        "playerListToggle": 1,
        "adminViewer": 0,
        "reserveFlag": 0,
        "clientStartSuccess": 1,
        "clientSuccessDate": "1706843708664",
        "useSdkFlag": 0,
        "createDate": "1706843707148",
        "updateDate": "1706843709881",
        "appliName": "test33",
        "wm": "1"
      }
    ],
    "total": "1",
    "size": "15",
    "current": "1",
    "orders": [],
    "optimizeCountSql": true,
    "searchCount": true,
    "pages": "1"
  }
}
成功返回示例的参数说明
参数名 类型 说明
code string 无
message string 无
result object 无
records array 无
records.appliName string 应用名称
records.taskId string 任务Id
records.status string 运行状态，3运行中，9已结束
records.startProcType string 独占模式下启动模式，大部分为标准模式：0，少部分为兼容模式：1
records.startAt string 开始时间，时间戳（ms）
records.endAt string 结束时间，时间戳（ms）
records.serverId string 无
records.serverIp string 无
records.publicIp string 服务器公网ip
records.clientIp string 客户端ip
records.appliId string 应用Id
records.appliType string 应用类型： 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 string 1：公开应用、 0：私有应用
records.wsId string 工作空间Id
records.limitMaxFps string 在共享模式下是否限制应用本身的帧率，默认为1；0：否，1：是
records.offScreen string 是否离屏渲染，离屏渲染时能减少部分资源消耗，默认是1。 0：不是。1：是
records.useGamepad string 该应用是否使用手柄，默认为0；0：不使用，1：使用
records.dcs string 应用级别是否支持数据通道服务，1支持，0不支持
records.playMode string 应用级别是否支持互动模式，1支持，0不支持
records.scs string 应用是否使用智能语音服务，1使用，0不使用
records.audioInput string 是否开启客户端音频（麦克风）输入功能，1开启，0不开启
records.audioInputAutoStart string 是否自动开启麦克风，1开启，0不开启
records.videoInput string 是否开启客户端视频（摄像头）输入功能，1开启，0不开启
records.videoInputAutoStart string 是否自动开启摄像头
records.videoInputCnt string 应用使用的摄像头数量
records.liveStreaming string 是否开启直播推流，1开启，0不开启
records.qpMin string 编码qp最小值
records.qpMax string 编码qp最大值
records.taskCloseType string 实例关闭方式：0即时关闭(默认)、1延迟关闭
records.delayCloseDuration string 延迟关闭的延迟时间，单位秒，默认20秒
records.reqGpuMemMax string 最大GPU显存需求量（单位M）,用于分配请求时检查显存是否充足，默认值0：不考虑当前应用显存需求，只检查当前GPU显存使用量
records.useWebCodec string 是否使用WebCodec，0：不使用、1：使用
records.preferDecoder string 优先使用的解码格式标准：’auto’ 、’vp8’ 、 ‘vp9’ 、 ‘h264’ 、 ‘h265’ 、’hevc’ 、’av1’ 、’av1x’,默认值h264
records.playerMode string 应用级别是否支持互动模式，1支持，0不支持
records.playerListToggle string 演示/互动模式是否显示玩家列表，默认为1；0：否，1：是
records.adminViewer string 是否是远程桌面功能。0：否 1：是
records.reserveFlag string 是否使用了预启动。0：否 1：是
records.clientStartSuccess string 客户端是否成功启动。0：否 1：是
records.clientSuccessDate string 客户端成功启动的时间戳（ms）
records.useSdkFlag string 是否使用了SDK
records.createDate string 无
records.updateDate string 无
total string 无
size string 无
current string 无
orders array 无
optimizeCountSql string 无
searchCount string 无
pages string 无
备注
admin 2025年3月12日 16:26 收藏文档

开发者交流群

QQ群号：1011308692