API中心服务端API应用管理
应用管理
查询用户的应用列表
请求地址: /api/3dcat/application/query
请求方法:GET
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
current | int | 是 | 当前页(从1开始) |
size | int | 是 | 一页数目 |
appName | String | 否 | 应用名称(模糊查询) |
type | int | 否 | 1 cloud3d 2 xR(默认值为1) |
roomId | Long | 否 | 房间id |
返回结果:
字段名 | 类型 | 说明 |
---|
current | int | id |
size | int | 用户名 |
total | int | 查询总数 |
records | List | 应用列表 |
应用
字段名 | 类型 | 说明 |
---|
id | Long | 应用Id |
appliName | String | 应用名称 |
description | String | 描述 |
startFlag | String | "on" 上架,"off" 下架 |
appliType | String | 应用类型 2/共享GPU,1/独占GPU,3/OpenVR,4/VR |
instanceMax | String | 最大并发数量 |
syncStatus | String | 同步状态 Y:同步中 P发布中 C 覆盖中 ERROR:发布失败 COVER_ERROR:覆盖失败 空字符串 发布成功 |
userId | Long | 用户id |
fileSize | String | 文件大小(单位为字节 ) |
picUrl | String | 应用缩略图地址 |
createTime | Date | 创建时间 |
updateTime | Date | 应用时间 |
engineType | int | 引擎类型 2/unreal,unity/1,0/other |
initCursorMode | String | 鼠标模式,默认是0。0:非锁定模式。1:锁定模式 |
operator | String | 鼠标模式,wm,hk,sys,wmhk |
type | 应用类型 | 类型1 3d 2 vr |
roomId | Long | 房间id |
concurrency | String | 当前并发数 |
返回内容示例:
{
"version":"1.0.0",
"result":true,
"message":"success",
"code":200,
"data":{
"records":[
{
"id":1812,
"appliName":"汽车",
"description":"",
"startFlag":"on",
"appliType":"2",
"instanceMax":"3",
"syncStatus":"",
"userId":43334,
"fileSize":"80166372",
"picUrl":"",
"createTime":"2021-06-29T08:21:10.000+0000",
"updateTime":"2021-06-29T08:21:30.000+0000",
"engineType":2,
"initCursorMode":"0",
"operator":"wmhk",
"type":2,
"roomId":1051,
"concurrency":0
}
],
"total":1,
"size":10,
"current":1,
"orders":[
],
"searchCount":true,
"pages":1
},
"serverTime":1626077249763,
"requestId":"9c11979f95398fd0"
}
查询用户所有应用列表
请求地址: /api/3dcat/application/all
说明:此接口用于应用覆盖时查询该用户所有应用列表接口
请求方法:get
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
type | int | 否 | 应用类型 1:3d 2:vr 3:全部 默认1 |
返回结果:
字段名 | 类型 | 说明 |
---|
id | Long | 应用Id |
appliName | String | 应用名称 |
返回内容示例:
{
"version":"1.0.0",
"result":true,
"message":"success",
"code":200,
"data":[
{
"id":33,
"appliName":"汽车"
}
],
"serverTime":1626080941713,
"requestId":"3f66fde6517a86b9"
}
查询单个应用详情
请求地址: /api/3dcat/application/{id}/info
说明需将{id}替换成应用id
请求方法:get
请求参数:
返回结果:
字段名 | 类型 | 说明 |
---|
id | Long | 应用Id |
appliName | String | 应用名称 |
description | String | 描述 |
appId | String | 应用分享生成的id |
appSecret | String | 分享密钥 |
param | String | 应用运行附加参数 |
graphicsCardType | String | 显卡类型 |
initWinSize | String | 初始化窗口方式0:按照原始窗口大小显示1:按所选分辨率显示2:尽量填充容器(保存宽高比)3:完全填充容器(裁剪)4:完全填充容器(拉伸)默认为1: 按所选分辨率显示 |
exeFileName | String | 可执行文件名称 |
hasExtraParam | String | 接口调用是否附加参数 N(否)、Y(是) |
appliPath | String | 固定 "/" |
zipFile | String | 压缩包全名 |
virtualComponent | int | 控制虚拟控件显示 1 (默认),2 ,3 都不显示 |
appShareLink | String | 应用分享链接 |
startTime | Date | 链接开始时间 |
endTime | Date | 链接结束时间 |
gpuOccupancy | int | gpu预计占用率 |
cpuOccupancy | int | cpu预计占用率 |
memoryOccupancy | int | 内存预计占用率 |
videoMemoryOccupancy | int | 显存预计占用率 |
startFlag | String | "on" 上架,"off" 下架 |
appliType | String | 应用类型 2/共享GPU,1/独占GPU,3/OpenVR,4/VR |
instanceMax | String | 最大并发数量 |
syncStatus | String | 同步状态 Y:同步中 P发布中 C 覆盖中 ERROR:发布失败 COVER_ERROR:覆盖失败 空字符串 发布成功 |
userId | Long | 用户id |
fileSize | String | 文件大小(单位为字节 ) |
picUrl | String | 应用缩略图地址 |
createTime | Date | 创建时间 |
updateTime | Date | 应用时间 |
engineType | int | 引擎类型 2/unreal,unity/1,0/other |
initCursorMode | String | 鼠标模式,默认是0。0:非锁定模式。1:锁定模式 |
operator | String | 鼠标模式,wm,hk,sys,wmhk |
type | 应用类型 | 类型1 3d 2 vr |
roomId | Long | 房间id |
concurrency | String | 当前并发数 |
返回内容示例:
{
"version":"1.0.0",
"result":true,
"message":"success",
"code":200,
"data":{
"id":1812,
"appliName":"汽车",
"fileSize":"80166372",
"description":"",
"appKey":null,
"appSecret":null,
"param":"",
"graphicsCardType":"1",
"appliType":"2",
"resolutionRatio":"1280*720",
"initWinSize":"1",
"exeFileName":"VRCar/VRCar.exe",
"picUrl":"",
"hasExtraParam":"Y",
"instanceMax":"3",
"appliPath":"/",
"zipFile":"vrcar.zip",
"runCnt":0,
"engineType":2,
"startFlag":"on",
"initCursorMode":"0",
"operator":"wmhk",
"virtualComponent":1,
"roomId":"1051",
"type":"2",
"appShareLink":null,
"startTime":null,
"endTime":null,
"gpuOccupancy":null,
"cpuOccupancy":null,
"memoryOccupancy":null,
"videoMemoryOccupancy":null,
"concurrency":0
},
"serverTime":1626081320960,
"requestId":"4cbd4f5d2b3746e9"
}
创建应用
请求地址: /api/3dcat/application/publish
请求方法: POST
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
appliName | String | 是 | 应用名称 |
description | String | 否 | 描述 |
param | String | 否 | 应用运行附加参数 |
graphicsCardType | String | 否 | 显卡类型,1/1660Ti,2/2080 (type为1时必传) |
initWinSize | String | 否 | 初始化窗口方式0:按照原始窗口大小显示1:按所选分辨率显示2:尽量填充容器(保存宽高比)3:完全填充容器(裁剪)4:完全填充容器(拉伸)默认为1: 按所选分辨率显示 (type=1必传) |
exeFileName | String | 否 | 可执行文件名称(需调用/api/3dcat/file/getExePath接口获取) |
hasExtraParam | String | 否 | 接口调用是否附加参数 N(否)、Y(是) type为1 必传 |
appliPath | String | 是 | 固定值"/" |
zipFile | String | 是 | 压缩包全名 |
virtualComponent | int | 否 | 控制虚拟控件显示 1 (默认),2 ,3 都不显示 (type为1时必传) |
gpuOccupancy | int | 否 | gpu预计占用率 范围为10-90 |
cpuOccupancy | int | 否 | cpu预计占用率 范围为10-90 |
memoryOccupancy | int | 否 | 内存预计占用率 范围10-90 |
videoMemoryOccupancy | int | 否 | 显存预计占用率 范围为10-90 |
appliType | String | 否 | 应用类型 2/共享GPU,1/独占GPU (type为1时必传) |
instanceMax | String | 是 | 最大并发数量 |
fileSize | String | 是 | 文件大小(单位为字节 ) |
imageId | Long | 否 | 图片上传时返回的id(当picUrl有值为必填) |
picUrl | String | 否 | 应用缩略图地址 |
engineType | int | 是 | 引擎类型 2/unreal,unity/1,0/other |
operator | String | 否 | wm:只用绝对坐标(程序启动后,鼠标一直显示在应用中,未锁定) hk:只用相对坐标(程序启动后,鼠标锁定在应用中,并被隐藏 sys:独占系统的键鼠 wmhk:点击时用绝对坐标,移动时用相对坐标鼠标模式,wm,hk,sys,wmhk (type=1必传) |
type | 应用类型 | 是 | 类型1 3d 2 vr |
roomId | Long | 否 | 房间id (type 为2时才需要房间) |
返回结果:
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"serverTime": 1625826814401,
"requestId": "71339b2af9ff2325"
}
编辑应用
请求地址: /api/3dcat/application/upShelf
请求方法: POST
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
id | Long | 是 | 应用id |
appliName | String | 是 | 应用名称 |
description | String | 否 | 描述 |
param | String | 否 | 应用运行附加参数 |
graphicsCardType | String | 否 | 显卡类型,1/1660Ti,2/2080 (type为1时必传) |
initWinSize | String | 否 | 初始化窗口方式0:按照原始窗口大小显示1:按所选分辨率显示2:尽量填充容器(保存宽高比)3:完全填充容器(裁剪)4:完全填充容器(拉伸)默认为1: 按所选分辨率显示 (type=1必传) |
exeFileName | String | 否 | 可执行文件名称(需调用/api/3dcat/file/getExePath接口获取) |
hasExtraParam | String | 否 | 接口调用是否附加参数 N(否)、Y(是) type为1 必传 |
virtualComponent | int | 否 | 控制虚拟控件显示 1 (默认),2 ,3 都不显示 (type为1时必传) |
gpuOccupancy | int | 否 | gpu预计占用率 范围为10-90 |
cpuOccupancy | int | 否 | cpu预计占用率 范围为10-90 |
memoryOccupancy | int | 否 | 内存预计占用率 范围10-90 |
videoMemoryOccupancy | int | 否 | 显存预计占用率 范围为10-90 |
appliType | String | 否 | 应用类型 2/共享GPU,1/独占GPU (type为1时必传) |
instanceMax | String | 是 | 最大并发数量 |
imageId | Long | 否 | 图片上传时返回的id(当picUrl有值为必填) |
picUrl | String | 否 | 应用缩略图地址 |
engineType | int | 是 | 引擎类型 2/unreal,unity/1,0/other |
operator | String | 否 | wm:只用绝对坐标(程序启动后,鼠标一直显示在应用中,未锁定) hk:只用相对坐标(程序启动后,鼠标锁定在应用中,并被隐藏 sys:独占系统的键鼠 wmhk:点击时用绝对坐标,移动时用相对坐标鼠标模式,wm,hk,sys,wmhk (type=1必传) |
type | 应用类型 | 是 | 类型1 3d 2 vr |
roomId | Long | 否 | 房间id (type 为2时才需要房间) |
返回结果:
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"serverTime": 1625826814401,
"requestId": "71339b2af9ff2325"
}
覆盖应用
请求地址: /api/3dcat/application/upShelf
请求方法: POST
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
id | Long | 是 | 应用id |
zipFile | String | 是 | 用于更新的资产压缩包名称 |
appliPath | String | 是 | 固定值"/" |
description | String | 否 | 描述 |
param | String | 否 | 应用运行附加参数 |
graphicsCardType | String | 否 | 显卡类型,1/1660Ti,2/2080 (type为1时必传) |
initWinSize | String | 否 | 初始化窗口方式0:按照原始窗口大小显示1:按所选分辨率显示2:尽量填充容器(保存宽高比)3:完全填充容器(裁剪)4:完全填充容器(拉伸)默认为1: 按所选分辨率显示 (type=1必传) |
exeFileName | String | 否 | 可执行文件名称(需调用/api/3dcat/file/getExePath接口获取) |
hasExtraParam | String | 否 | 接口调用是否附加参数 N(否)、Y(是) type为1 必传 |
virtualComponent | int | 否 | 控制虚拟控件显示 1 (默认),2 ,3 都不显示 (type为1时必传) |
gpuOccupancy | int | 否 | gpu预计占用率 范围为10-90 |
cpuOccupancy | int | 否 | cpu预计占用率 范围为10-90 |
memoryOccupancy | int | 否 | 内存预计占用率 范围10-90 |
videoMemoryOccupancy | int | 否 | 显存预计占用率 范围为10-90 |
appliType | String | 否 | 应用类型 2/共享GPU,1/独占GPU (type为1时必传) |
instanceMax | String | 是 | 最大并发数量 |
fileSize | String | 是 | 文件大小(单位为字节 ) |
imageId | Long | 否 | 图片上传时返回的id(当picUrl有值为必填) |
picUrl | String | 否 | 应用缩略图地址 |
engineType | int | 是 | 引擎类型 2/unreal,unity/1,0/other |
operator | String | 否 | wm:只用绝对坐标(程序启动后,鼠标一直显示在应用中,未锁定) hk:只用相对坐标(程序启动后,鼠标锁定在应用中,并被隐藏 sys:独占系统的键鼠 wmhk:点击时用绝对坐标,移动时用相对坐标鼠标模式,wm,hk,sys,wmhk (type=1必传) |
type | 应用类型 | 是 | 类型1 3d 2 vr |
roomId | Long | 否 | 房间id (type 为2时才需要房间) |
返回结果:
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"serverTime": 1625826814401,
"requestId": "71339b2af9ff2325"
}
删除应用
请求地址:/api/3dcat/application/delete/{id}
说明: 请求时替换{id}为应用id
请求方法: delete
请求参数:
返回结果:
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"serverTime": 1625826814401,
"requestId": "71339b2af9ff2325"
}
上下架应用
请求地址: /api/3dcat/application/offShelf
请求方法: put
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
id | Long | 是 | 应用id |
status | String | 是 | "on":上架 "off":下架 |
返回结果:
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"serverTime": 1625826814401,
"requestId": "71339b2af9ff2325"
}
更新应用房间号
请求地址: /api/3dcat/application/updateRoom
请求方法: put
请求参数:
字段名 | 类型 | 是否必填 | 说明 |
---|
id | Long | 是 | 应用id |
roomId | Long | 否 | 房间id |
返回结果:
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"serverTime": 1625826814401,
"requestId": "71339b2af9ff2325"
}
重置覆盖失败的应用
请求地址: /api/3dcat/application/resetCover
请求方法: put
请求参数:
返回结果:
返回内容示例:
{
"version": "1.0.0",
"result": true,
"message": "success",
"code": 200,
"serverTime": 1625826814401,
"requestId": "71339b2af9ff2325"
}