LarkXR3.3接口文档
获取凭证的签名
接口变更文档
基础版接口
获取应用列表
进入应用
获取进入应用Url
获取运行数
获取节点数和总并发数
生成authCode
获取区域信息
获取附加参数
获取task
开发版接口
程序包管理
查询程序包一览
创建程序包
更新程序包
删除程序包
上传zip包
获取UploadId
分片上传(推荐)
整体上传(不推荐)
二进制流式上传(不推荐)
应用管理
查询应用一览
上传封面图
创建应用
更新应用
更新应用状态
删除应用
预启动
查询预启动应用一览
添加预启动信息
更新预启动信息
删除预启动实例
进程管理
获取运行应用一览
批量停止正在运行的应用
接入管理
查询接入管理一览
创建接入凭证
更新接入凭证
删除接入凭证
更新接入凭证秘钥
工作空间
查询工作空间一览
创建工作空间
更新工作空间
删除工作空间
生成/更新工作空间秘钥
清除工作空间秘钥
节点管理
查询渲染节点一览
获取服务端资源监控数据
远程桌面
批量删除渲染节点
VR终端管理
获取VR/AR终端
获取客户端资源使用数据
VR客户端监控画面
获取渲染性能监控数据
组别管理
查询组别一览
添加组别
更新组别
删除组别
设置组别运行模式
获取组别运行模式
渲染服务器绑定组别(单个)
渲染服务器绑定组别(批量)
渲染服务器解绑定组别
使用统计
获取使用次数最高的10个应用
获取使用时长最高的10个应用-克隆
按省统计使用次数
某个省各市使用次数
其他使用次数
使用次数
使用时长
参数设置
获取参数设置信息
端口映射
查询
新增端口映射
更新端口映射
删除端口映射
定制Logo
查询免费版Logo
查询开发版Logo
更新免费版、开发版Logo
清除免费版Logo
恢复开发版Logo
无操作超时
查询
更新
安全
查询是否开启应用一览页面
设置是否开启应用一览页面
查询IP黑白名单
新增黑白名单
删除黑白名单
存储
查询
存储类型更新
是否保存VR监控数据更新
VR监控数据保存期限更新
VR是否保存服务器资源使用率数据更新
设置授权码
其他
获取系统名称
获取系统信息
-
+
首页
获取task
## 1. 接口说明 - 接口路径:`/taskInfo/getTask` - 请求方式:`GET` - 接口用途:根据 `taskId` 获取指定任务实例的运行信息 - 鉴权要求:无需登录鉴权,属于开放接口 > 说明:该接口会根据请求来源返回不同字段。普通外部请求会隐藏部分敏感字段;当请求头中携带 `X-Lark-XR-Request: LARK_XR_AGENT` 时,会返回更多供渲染节点使用的启动信息。 ## 2. 请求参数 | 参数名 | 位置 | 类型 | 必填 | 说明 | | --- | --- | --- | --- | --- | | `taskId` | query | `Long` | 是 | 任务 ID | ## 3. 请求头 ### 3.1 普通调用 无特殊要求。 ### 3.2 Agent / 渲染节点调用 当请求头包含以下内容时,接口会返回更多启动参数和节点侧配置: | Header | 值 | | --- | --- | | `X-Lark-XR-Request` | `LARK_XR_AGENT` | ## 4. 请求示例 ### 4.1 普通请求 ```http GET /taskInfo/getTask?taskId=10001 HTTP/1.1 Host: your-domain ``` ### 4.2 Agent 请求 ```http GET /taskInfo/getTask?taskId=10001 HTTP/1.1 Host: your-domain X-Lark-XR-Request: LARK_XR_AGENT ``` ## 5. 返回结构 接口统一返回 `RespResult<TaskInfo>` 结构: | 字段 | 类型 | 说明 | | --- | --- | --- | | `code` | `int` | 返回码,成功为 `1000` | | `message` | `string` | 返回信息,成功通常为 `Success` | | `result` | `object` | 任务信息对象,对应 `TaskInfo` | ## 6. 成功响应示例 ### 6.1 普通请求示例 ```json { "code": 1000, "message": "Success", "result": { "taskId": 10001, "status": 3, "startProcType": 0, "startAt": 1719212345678, "endAt": null, "serverId": "srv-001", "serverIp": null, "publicIp": null, "clientId": 12, "clientIp": null, "appliId": 3001, "appliType": 1, "accessType": 0, "wsId": "ws_demo", "dcs": 1, "playMode": 1, "scs": 0, "audioInput": 1, "audioInputAutoStart": 0, "videoInput": 0, "liveStreaming": 0, "authCode": null, "sdkId": null, "startParam": null, "wm": "1", "shareUrl": "false", "scsType": null, "imeFirstNotice": 1 } } ``` ### 6.2 Agent 请求示例 ```json { "code": 1000, "message": "Success", "result": { "taskId": 10001, "status": 1, "serverId": "srv-001", "serverIp": "10.0.0.8", "publicIp": "203.0.113.10", "appliId": 3001, "wsId": "ws_demo", "startParam": "/data/app/demo/demo.exe --taskId=10001", "dcs": 1, "scs": 1, "audioInput": 1, "videoInput": 1, "videoInputCnt": 1, "liveStreaming": 0, "wm": "1", "shareUrl": "true", "scsType": 1, "reqGpuMemMax": 2048, "gpuMemUsageLimit": 90, "qpMin": 20, "qpMax": 45, "taskCloseType": 0, "delayCloseDuration": 20, "useWebCodec": 1, "preferDecoder": "h264", "arAlphaMask": 0, "snapWindow": 0, "snapWinTitle": "", "snapWinClassName": "", "imeFirstNotice": 1, "initResolutionType": 0 } } ``` ## 7. `result` 主要字段说明 ### 7.1 基础字段 | 字段 | 类型 | 说明 | | --- | --- | --- | | `taskId` | `Long` | 任务 ID | | `status` | `Integer` | 任务状态:`0` 同步中,`1` 就绪,`3` 运行中,`9` 已结束 | | `startProcType` | `Integer` | 启动进程类型 | | `startParam` | `String` | 应用启动参数;普通请求默认隐藏,Agent 请求可见 | | `startAt` | `Long` | 启动时间戳(毫秒) | | `endAt` | `Long` | 结束时间戳(毫秒) | | `serverId` | `String` | 渲染服务器 ID | | `serverIp` | `String` | 渲染服务器内网 IP;普通请求默认隐藏,且存在 `publicIp` 时会被置空 | | `publicIp` | `String` | 渲染服务器外网 IP;普通请求默认隐藏 | | `clientId` | `Integer` | 客户端 ID | | `clientIp` | `String` | 客户端 IP;普通请求默认隐藏 | | `appliId` | `Long` | 应用 ID | | `appliType` | `Integer` | 应用类型 | | `accessType` | `Integer` | 访问类型 | | `wsId` | `String` | 工作区 ID | ### 7.2 授权/能力相关字段 | 字段 | 类型 | 说明 | | --- | --- | --- | | `wm` | `String` | 水印控制:`false` 不显示,`1` 标准商业版,`2` 个人版,`3` 行业伙伴版 | | `dcs` | `Integer` | 是否启用数据通道:`1` 启用,`0` 禁用 | | `shareUrl` | `String` | 是否允许分享互动模式 URL:`true` / `false` | | `scs` | `Integer` | 是否启用智能语音:`1` 启用,`0` 禁用 | | `scsType` | `Integer` | 智能语音供应商,当前 `1` 表示 DUI | | `audioInput` | `Integer` | 是否启用麦克风输入:`1` 启用,`0` 禁用 | | `audioInputAutoStart` | `Integer` | 是否自动开启麦克风输入 | | `videoInput` | `Integer` | 是否启用摄像头输入:`1` 启用,`0` 禁用 | | `videoInputAutoStart` | `Integer` | 是否自动开启摄像头输入 | | `videoInputCnt` | `Integer` | 摄像头数量,仅 Agent 请求返回 | | `liveStreaming` | `Integer` | 是否启用直播推流:`1` 启用,`0` 禁用 | ### 7.3 Agent 扩展字段 以下字段主要在 `X-Lark-XR-Request: LARK_XR_AGENT` 场景下返回: | 字段 | 类型 | 说明 | | --- | --- | --- | | `reqGpuMemMax` | `Integer` | 应用请求的最大 GPU 显存(MB) | | `gpuMemUsageLimit` | `Integer` | GPU 显存使用率上限 | | `qpMin` | `Integer` | 编码最小 QP | | `qpMax` | `Integer` | 编码最大 QP | | `taskCloseType` | `Integer` | 实例关闭方式:`0` 即时关闭,`1` 延迟关闭 | | `delayCloseDuration` | `Integer` | 延迟关闭时长(秒) | | `useWebCodec` | `Integer` | 是否使用 WebCodec | | `preferDecoder` | `String` | 优先解码标准,如 `auto`、`h264`、`h265`、`vp8`、`vp9`、`av1` | | `arAlphaMask` | `Integer` | AR 透明通道配置 | | `snapWindow` | `Integer` | 是否启用窗口捕获 | | `snapWinTitle` | `String` | 捕获窗口标题 | | `snapWinClassName` | `String` | 捕获窗口类名 | | `imeFirstNotice` | `Integer` | 首次中文输入事件通知开关 | | `initResolutionType` | `Integer` | 初始化分辨率方式:`0` 应用默认分辨率,`1` 适配客户端窗口 | ### 7.4 特殊字段 | 字段 | 类型 | 说明 | | --- | --- | --- | | `adminViewer` | `Integer` | 是否后台远程桌面访问:`1` 是,`0` 否 | | `authCode` | `String` | 访问口令;普通请求默认隐藏 | | `sdkId` | `String` | SDK ID;普通请求默认隐藏 | | `nickname` | `String` | 昵称 | | `playerMode` | `Integer` | 启动模式:`0` 普通模式,`1` 演示模式,`2` 互动模式 | | `playerListToggle` | `Integer` | 用户列表显示/隐藏开关 | ## 8. 失败响应 ### 8.1 参数缺失 当 `taskId` 为空时返回错误。 ```json { "code": 500, "message": "taskId is required", "result": null } ``` ### 8.2 任务不存在 ```json { "code": 500, "message": "Task does not exist", "result": null } ``` ### 8.3 授权校验失败 ```json { "code": 500, "message": "license check failed", "result": null } ``` ### 8.4 应用同步失败 当任务状态为“就绪”,且应用为 zip 包部署,但目标节点未找到已完成同步记录时,接口会返回失败: ```json { "code": 500, "message": "Application synchronize failed.", "result": null } ```
admin
2026年4月27日 13:43
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
开发者交流群
QQ群号:1011308692
Markdown文件
Word文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码
有效期