API中心服务端API应用管理
应用管理
查询用户的应用列表
请求方法:GET
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
current | int | 是 | 当前页(从1开始) |
size | int | 是 | 一页数目 |
name | String | 否 | 应用名称(模糊查询) |
appType | int | 否 | 1 cloud3d 2 xR(默认值为1) |
roomId | Long | 否 | 房间id |
id | Long | 否 | id |
返回结果:
字段名 | 类型 | 说明 |
---|
current | int | id |
size | int | 用户名 |
total | int | 查询总数 |
records | List | 应用列表 |
应用
字段名 | 类型 | 说明 |
---|
id | Long | 应用Id |
name | String | 应用名称 |
description | String | 描述 |
startFlag | String | "on" 上架,"off" 下架 |
instanceMax | String | 最大并发数量 |
syncStatus | String | 10:同步中 14:发布中 15:覆盖中 16:发布部分成功且同步中 17部分成功部分失败 40:覆盖失败 45:发布失败 20:发布成功 |
userId | Long | 用户id |
fileSize | String | 文件大小(单位为字节 ) |
picUrl | String | 应用缩略图地址 |
engineType | Integer | 引擎类型 1/ue4,unity/2,0/other |
type | 应用类型 | 类型1 3d 2 xr |
roomId | Long | 房间id |
concurrency | String | 当前并发数 |
gpuConfigId | Long | 指定机型 |
machineDes | String | 机型描述 |
createTime | Date | 创建时间 |
updateTime | Date | 应用时间 |
sharAppkey | String | 分享appkey |
shareAppSecret | String | 分享AppSecret |
shareId | Long | 分享Id |
appShareLink | String | app分享链接 |
castScreenAppKey | String | 投屏appKey |
castScreenAppSecret | String | 投屏AppSecret |
castScreenShareLink | String | 投屏分享链接 |
castScreenShareId | Long | 投屏的分享id |
pushStreamType | Integer | 推流方式 |
showCastScreenUsers | Integer | 是否显示投屏用户列表 0不显示 1显示 |
publishTime | LocalDateTime | 发布时间 |
appPath | String | 应用路径 |
auditStatus | Integer | 审核状态 0 创建中 1等待审核 2审核中 3 通过 -1 审核不通过 -2审核終止(创建失败或者超时覆盖失败时) |
auditId | Long | 审核id |
auditTime | LocalDateTime | 审核时间 |
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"data": {
"records": [
{
"id": 945,
"name": "202206242029",
"description": "",
"startFlag": "on",
"instanceMax": "1",
"syncStatus": 20,
"userId": 3841,
"fileSize": "15929354",
"picUrl": null,
"engineType": 1,
"type": null,
"roomId": null,
"concurrency": 0,
"gpuConfigId": null,
"machineDes": null,
"createTime": "2022-06-24 20:29:24",
"updateTime": "2022-06-24 20:29:37",
"shareAppKey": null,
"shareAppSecret": null,
"shareId": null,
"appShareLink": null,
"castScreenAppKey": null,
"castScreenAppSecret": null,
"castScreenShareLink": null,
"castScreenShareId": null,
"pushStreamType": 1,
"showCastScreenUsers": 1,
"publishTime": "2022-06-24 20:29:27",
"appPath": "/945/1656073764/",
"auditStatus": 2,
"auditId": null,
"auditTime": null
}
],
"total": 1,
"size": 10,
"current": 1,
"orders": [],
"optimizeCountSql": true,
"hitCount": false,
"countId": null,
"maxLimit": null,
"searchCount": true,
"pages": 1
},
"serverTime": 1657002276536,
"requestId": "39f9a8a7748f130a"
}
查询应用分享列表
请求方法:GET
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
current | int | 是 | 当前页(从1开始) |
size | int | 是 | 一页数目 |
name | String | 否 | 应用名称(模糊查询) |
appType | int | 否 | 1 cloud3d 2 xR(默认值为1) |
roomId | Long | 否 | 房间id |
id | Long | 否 | id |
返回结果:
字段名 | 类型 | 说明 |
---|
current | int | id |
size | int | 用户名 |
total | int | 查询总数 |
records | List | 应用列表 |
应用
字段名 | 类型 | 说明 |
---|
id | Long | 应用Id |
name | String | 应用名称 |
description | String | 描述 |
startFlag | String | "on" 上架,"off" 下架 |
appType | String | 应用类型 |
instanceMax | String | 最大并发数量 |
syncStatus | String | 10:同步中 14:发布中 15:覆盖中 16:发布部分成功且同步中 17部分成功部分失败 40:覆盖失败 45:发布失败 20:发布成功 |
userId | Long | 用户id |
fileSize | String | 文件大小(单位为字节 ) |
picUrl | String | 应用缩略图地址 |
appShareLink | String | app分享链接 |
userName | String | 用户名称 |
type | 应用类型 | 类型1 3d 2 xr |
roomId | Long | 房间id |
engineType | Integer | 引擎类型 1/ue4,unity/2,0/other |
concurrency | String | 当前并发数 |
isDelete | Integer | 是否删除 |
createTime | LocalDateTime | 创建时间 |
updateTime | LocalDateTime | 应用时间 |
sharAppkey | String | 分享appkey |
shareId | Long | 分享Id |
gpuConfigId | Long | 指定机型 |
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"data": {
"records": [
{
"id": 945,
"name": "202206242029",
"description": "",
"startFlag": "on",
"appType":"",
"instanceMax": "1",
"syncStatus": 20,
"userId": 3841,
"fileSize": "15929354",
"picUrl": null,
"appShareLink": null,
"userName": null,
"type": null,
"roomId": null,
"engineType": 1,
"concurrency": 0,
"isDelete": null,
"createTime": "2022-06-24 20:29:24",
"updateTime": "2022-06-24 20:29:37",
"shareAppKey": null,
"shareId": null,
"gpuConfigId": null,
}
],
"total": 1,
"size": 10,
"current": 1,
"orders": [],
"optimizeCountSql": true,
"hitCount": false,
"countId": null,
"maxLimit": null,
"searchCount": true,
"pages": 1
},
"serverTime": 1657002276536,
"requestId": "39f9a8a7748f130a"
}
查询用户所有应用列表
说明:此接口用于应用覆盖时查询该用户所有应用列表接口
请求方法:get
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
type | int | 否 | 应用类型 1:3d 2:vr 3:全部 默认1 |
fileId | Long | 否 | 文件id |
返回结果:
字段名 | 类型 | 说明 |
---|
id | Long | 应用Id |
name | String | 应用名称 |
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"data": [
{
"id": 417,
"name": "3dcat12"
}
],
"serverTime": 1638779799746,
"requestId": "9c53d367e9a9bd6e"
}
查询单个应用详情
说明需将{id}替换成应用id
请求方法:get
请求参数:
返回结果:
字段名 | 类型 | 说明 |
---|
id | Long | 应用Id |
name | String | 应用名称 |
fileSize | String | 文件大小 |
description | String | 描述 |
appKey | String | appKey |
appSecret | String | 分享密钥 |
param | String | 应用运行附加参数 |
appType | int | 应用类型 2/共享GPU,1/独占GPU,3/OpenVR |
picUrl | String | 应用缩略图地址 |
instanceMax | String | 最大并发数 |
appPath | String | 固定 "/" |
exePath | String | 可执行程序路径,应用启动文件名 |
zipFile | String | 压缩包全名 |
parentFile | String | 父目录 |
engineType | Integer | 引擎类型 2/unreal,unity/1,0/other |
startFlag | String | "on" 上架,"off" 下架 |
virtualComponent | Integer | 控制虚拟控件显示 1 (默认),2 ,3 都不显示 |
roomId | Long | 房间id |
appShareLink | String | 应用分享链接 |
shareStartTime | Date | 链接开始时间 |
shareEndTime | Date | 链接结束时间 |
concurrency | String | 当前并发数 |
gpuConfigId | Long | 指定机型 |
machineDes | String | 机型描述 |
keyboardMappingId | Long | 预设方案id(与键鼠映射配置二选一) |
keyboardMappingConfig | String | 键鼠映射配置(与预设方案id二选一) |
syncStatus | Integer | 同步状态:14发布中 15覆盖中 16发布部分成功且同步中 17 部分成功部分失败 40 覆盖失败 45 发布失败 20发布成功" |
pushStreamType | Integer | 推流方式 |
needPort | Integer | 是否开启端口 |
settingHoverButton | Integer | 终端设置悬浮按钮 1/移动端展示 2/pc端展示 3/都显示 |
inputHoverButton | Integer | 终端输入悬浮按钮 1/排除端展示 |
fileId | Long | 文件id |
exePaths | List | 可执行文件列表 |
onShelfTime | LocalDateTime | 上架时间 |
showCastScreenUsers | Integer | 显示投屏用户列表 默认显示0不显示 1显示 |
castScreenAppShareLink | String | 应用投屏分享链接 |
castScreenShareStartTime | Date | 投屏链接开始时间 |
castScreenShareEndTime | Date | 投屏链接结束时间 |
castScreenAppKey | String | 投屏应用key |
castScreenAppSecret | String | 投屏应用密钥 |
publishTime | LocalDateTime | 发布时间 |
needLandscape | Integer | 终端默认横屏 移动端 |
landscapeType | Integer | 1/自适应 2/拉伸 3/裁剪 |
auditStatus | Integer | 审核状态 0 创建中 1等待审核 2审核中 3 通过 -1 审核不通过 -2审核終止(创建失败或者超时覆盖失败时) |
openMicrophone | Boolean | 语音交互 默认不开启 |
openMultiTouch | Boolean | 多点触控 默认不开启 |
afk | Integer | afk |
defaultAfk | Boolean | 是否为默认afk,0/非默认 1/默认 |
framerate | Integer | 帧率 |
billMethod | Integer | 计费方式 1/按量计费 2/套餐计费 |
newsletterType | Integer | 云端应用通信角色 1/客户端 2/服务端 |
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"data": {
"id": 1273,
"name": "111",
"fileSize": "490444979",
"description": "",
"appKey": "FZbSz7lap1jOzpG5",
"appSecret": "",
"param": "",
"appType": 1,
"picUrl": null,
"instanceMax": "1",
"appPath": "/publish/3500/3841/1273/1665288460/",
"exePath": "WindowsNoEditor/shoot/Binaries/Win64/shoot.exe",
"zipFile": "/upload/3500/3841/shoot1.zip",
"parentFile": "1665288460",
"engineType": null,
"startFlag": "on",
"virtualComponent": null,
"roomId": null,
"appShareLink": "https://app-pre.3dcat.live:14431/raystreaming/rayvision/player-normal.html?appKey=FZbSz7lap1jOzpG5",
"shareStartTime": null,
"shareEndTime": null,
"concurrency": 0,
"gpuConfigId": 59,
"machineDes": null,
"keyboardMappingId": null,
"keyboardMappingConfig": null,
"syncStatus": 20,
"pushStreamType": 1,
"settingHoverButton": 3,
"inputHoverButton": null,
"fileId": 1470,
"exePaths": null,
"onShelfTime": "2022-10-09 12:07:41",
"showCastScreenUsers": 1,
"castScreenAppShareLink": null,
"castScreenShareStartTime": null,
"castScreenShareEndTime": null,
"castScreenAppKey": null,
"castScreenAppSecret": null,
"publishTime": "2022-10-09 12:08:13",
"needLandscape": 1,
"landscapeType": 1,
"auditStatus": 1,
"openMicrophone": false,
"openMultiTouch": false,
"afk": 300,
"defaultAfk": true,
"framerate": 30,
"needPort": 1,
"billMethod": 1,
"newsletterType": null
},
"serverTime": 1666162151653,
"requestId": "b539168de9d46f62"
}
发布应用
请求方法: POST
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
name | String | 是 | 应用名称 |
fileSize | String | 否 | 应用大小 |
description | String | 否 | 应用描述 |
instanceMax | int | 否 | 应用最大同时运行数量 |
param | String | 否 | 启动参数 |
zipFile | String | 是 | 应用程序压缩包全路径名 |
exePath | String | 否 | 可执行程序路径,应用启动文件名(压缩包内的相对路径) |
roomId | Long | 否 | 房间id (type 为2时才需要房间) |
appType | int | 是 | 应用类型 2/共享GPU,1/独占GPU (type为1时必传) |
imageId | Long | 否 | 图片上传时返回的id(当picUrl有值为必填) |
picUrl | String | 否 | 应用缩略图地址 |
pushStreamType | int | 否 | 推流方式 1/2k 2/4k 3/不限制 |
settingHoverButton | Integer | 否 | 终端设置悬浮按钮 1/移动端展示 2/pc端展示 3/都显示 |
inputHoverButton | Integer | 否 | 终端输入悬浮按钮 1/排除端展示 |
needLandscape | Integer | 否 | 终端默认横屏 移动端 |
landscapeType | Integer | 否 | 1/自适应 2/拉伸 3/裁剪 |
openMicrophone | Boolean | 否 | 语音交互 默认不开启 |
openMultiTouch | Boolean | 否 | 多点触控 默认不开启 |
afk | Integer | 否 | afk |
defaultAfk | Boolean | 否 | 是否为默认afk,0/非默认 1/默认 |
framerate | Integer | 否 | 帧率 |
gpuConfigId | Long | 否 | 云渲染并发规则 |
返回结果:
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"data": null,
"serverTime": 1638779219133,
"requestId": "07c8df7523329c52"
}
删除应用
说明: 请求时替换{id}为应用id
请求方法: delete
请求参数:
返回结果:
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"data": null,
"serverTime": 1638779298047,
"requestId": "4dbf1ad8d3febd36"
}
编辑应用
请求方法: POST
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
id | Long | 是 | 应用id |
appType | int | 否 | 应用类型 2/共享GPU,1/独占GPU (type为1时必传) |
name | String | 是 | 应用名称 |
description | String | 否 | 描述 |
instanceMax | String | 是 | 最大并发数量 |
param | String | 否 | 应用运行附加参数 |
roomId | Long | 否 | 房间id (type 为2时才需要房间) |
exePath | String | 否 | 可执行程序路径,应用启动文件名 |
picUrl | String | 否 | 应用缩略图地址 |
imageId | Long | 否 | 图片上传时返回的id(当picUrl有值为必填) |
engineType | int | 是 | 引擎类型 2/unreal,unity/1,0/other |
virtualComponent | int | 否 | 控制虚拟控件显示 1 (默认),2 ,3 都不显示 (type为1时必传) |
pushStreamType | Integer | 否 | 推流方式 1/2k 2/4k 3/不限制 |
needPort | Integer | 否 | 是否开启终端与云端应用通信 |
settingHoverButton | Integer | 否 | 终端设置悬浮按钮 1/移动端展示 2/pc端展示 3/都显示 |
inputHoverButton | Integer | 否 | 终端输入悬浮按钮 1/排除端展示 |
needLandscape | Integer | 否 | 终端默认横屏 移动端 |
landscapeType | Integer | 否 | 1/自适应 2/拉伸 3/裁剪 |
openMicrophone | Boolean | 否 | 语音交互 默认不开启 |
openMultiTouch | Boolean | 否 | 多点触控 默认不开启 |
afk | Integer | 否 | afk |
defaultAfk | Boolean | 否 | 是否为默认afk,0/非默认 1/默认 |
framerate | Integer | 否 | 帧率 |
newsletterType | Integer | 否 | 云端应用通信角色 1/客户端 2/服务端 |
gpuConfigId | Integer | 否 | 云渲染并发规则 |
needPort | Integer | 否 | 是否开启终端与云端应用通信 |
返回结果:
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"data": null,
"serverTime": 1638779153077,
"requestId": "b789be497b7deae9"
}
覆盖应用
请求方法: POST
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
id | Long | 是 | 应用id |
zipFile | String | 是 | 用于更新的资产压缩包名称 |
exePath | String | 否 | 可执行程序路径,应用启动文件名 |
appType | int | 否 | 应用类型 2/共享GPU,1/独占GPU (type为1时必传) |
name | String | 是 | 应用名称 |
fileSize | String | 是 | 文件大小(单位为字节) |
description | String | 否 | 描述 |
instanceMax | String | 是 | 最大并发数量 |
exeParam | String | 否 | 启动参数 |
engineType | int | 是 | 引擎类型 2/unreal,unity/1,0/other |
roomId | Long | 否 | 房间id (type 为2时才需要房间) |
imageId | Long | 否 | 图片上传时返回的id(当picUrl有值为必填) |
picUrl | String | 否 | 应用缩略图地址 |
virtualComponent | int | 否 | 控制虚拟控件显示 1 (默认),2 ,3 都不显示 (type为1时必传) |
pushStreamType | Integer | 否 | 推流方式 1/2k 2/4k 3/不限制 |
showCastScreenUsers | Integer | 否 | 显示投屏用户列表0不显示 1显示 |
settingHoverButton | Integer | 否 | 端设置悬浮按钮 1/移动端展示 2/pc端展示 3/都显示 |
inputHoverButton | Integer | 否 | 终端输入悬浮按钮 1/排除端展示 |
needLandscape | Integer | 否 | 终端默认横屏 移动端 |
landscapeType | Integer | 否 | 1/自适应 2/拉伸 3/裁剪 |
openMicrophone | Boolean | 否 | 语音交互 默认不开启 |
openMultiTouch | Boolean | 否 | 多点触控 默认不开启 |
afk | Integer | 否 | afk |
gpuConfigId | Long | 否 | 云渲染并发规则 |
返回结果:
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"data": null,
"serverTime": 1638779451365,
"requestId": "da2832600c9ab932"
}
上下架应用
请求方法: put
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
id | Long | 是 | 应用id |
status | String | 是 | "on":上架 "off":下架 |
返回结果:
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"data": null,
"serverTime": 1637812904201,
"requestId": "560055f1bd6f5f3f"
}
更新应用房间号
请求方法: put
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
id | Long | 是 | 应用id |
roomId | Long | 否 | 房间id |
返回结果:
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"data": null,
"serverTime": 1638780466697,
"requestId": "e044554eaac6c345"
}
重置覆盖失败的应用
请求方法: put
请求参数:
返回结果:
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"data": null,
"serverTime": 1638780387512,
"requestId": "1194fc0cedd0e132"
}
修改应用启动的机型
请求方法: put
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
appId | Long | 是 | 应用id |
gpuId | Long | 否 | 机型id |
返回结果:
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"data": null,
"serverTime": 1638780387512,
"requestId": "1194fc0cedd0e132"
}
设置应用键鼠映射
请求方法: put
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
appId | Long | 否 | 应用id |
keyboardMappingId | Long | 否 | 预设方案id(与键鼠映射配置二选一) |
keyboardMappingConfig | String | 否 | 键鼠映射配置(与预设方案id二选一) |
返回结果:
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"data": null,
"serverTime": 1638780743710,
"requestId": "9288bf29d32295f7"
}
查询审核信息
请求方法: Get
请求参数:
返回结果:
字段名 | 类型 | 说明 |
---|
id | Long | id |
appId | String | 应用id |
auditStatus | String | 审核状态 0 创建中 1等待审核 2审核中 3 通过 -1 审核不通过 -2审核終止(创建失败或者超时覆盖失败时) |
auditReason | String | 审核理由 |
createTime | LocalDateTime | 创建时间 |
updateTime | LocalDateTime | 更新时间 |
返回内容示例:
{
"code": 0,
"data": {
"appId": 0,
"auditReason": "",
"auditStatus": 0,
"createTime": "",
"id": 0,
"updateTime": ""
},
"message": "",
"requestId": "",
"result": true,
"serverTime": 0,
"version": ""
}
应用启动
请求方法:POST
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
appId | Long | 是 | 应用id |
bitrate | Integer | 否 | 码率 |
framerate | Integer | 否 | 帧率 |
videoGopInterval | Integer | 否 | 关键帧间隔 |
type | String | 否 | rayvision,CloudXR 默认rayvision |
protocol | String | 否 | tcp,udp 默认udp |
exeParameter | String | 否 | 应用启动参数 |
clientIp | String | 否 | 客户端ip |
platformId | Integer | 否 | 平台ip |
screencastPwd | String | 否 | 投屏密码 |
screencastMaxConcurrency | Integer | 否 | 投屏最大并发 |
shareId | Long | 否 | 分享id |
optionalParam | String | 否 | optionalParam |
joinType | Integer | 否 | 投屏专享 加入方式 1 口令 2链接 |
externalPort | Boolean | 否 | 是否为外部端口 |
返回结果:
返回内容示例:
{
"code": 0,
"data": "",
"message": "",
"requestId": "",
"result": true,
"serverTime": 0,
"version": ""
}
获取应用播放链接
请求方法:Get
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
appKey | String | 是 | appKey |
appSecret | String | 否 | 链接密码 |
castScreenPwd | String | 否 | 投屏密码 |
castScreenNickname | String | 否 | 投屏昵称 |
castScreenMaxQty | Integer | 否 | 并发数 |
isCastScreenMaster | Boolean | 否 | 是否是主控端 |
platform | Integer | 否 | 平台号 |
isMirror | Integer | 否 | 是否镜像 |
clientIp | String | 否 | 客户端ip |
minBitrate | Integer | 否 | 最小码率 |
maxBitrate | Integer | 否 | 最大码率 |
startBitrate | Integer | 否 | 初始码率 |
optionalParam | String | 否 | 自定义动态参数 |
joinType | Integer | 否 | 加入方式 |
externalPort | Boolean | 否 | 是否为外部端口 |
返回结果:
返回内容示例:
{
"version":"1.0.0",
"result":true,
"message":"success",
"code":200,
"data":"https: //app-pre.3dcat.live:4431/rtc-connect/player.html?config=eyJsb2FkaW5nTW9iaWxlSW1hZ2UiOiJodHRwczovL2FwcC1wcmUuM2RjYXQubGl2ZTo0NDMxL2ltYWdlcy8zNTAwLzM2ODEvMjAyMS8xMS8xNDYwMDg2MjgxOTk5NjE4MDQ4LmpwZyIsInZpcnR1YWxDb21wb25lbnQiOjEsImxvYWRpbmdQY0ltYWdlIjoiaHR0cHM6Ly9hcHAtcHJlLjNkY2F0LmxpdmU6NDQzMS9pbWFnZXMvMzUwMC8zNjgxLzIwMjEvMTEvMTQ2MDA4NjI1MTc4ODA0NjMzNi5qcGciLCJ0YXNrSWQiOjEyNDd9",
"serverTime":1626147836900,
"requestId":"0bf42a6d1eb31bef"
}