应用管理

查询用户的应用列表

请求地址: https://app.3dcat.live/api/3dcat/application/query

请求方法:GET

请求参数:

字段名类型是否必填说明
currentint当前页(从1开始)
sizeint一页数目
nameString应用名称(模糊查询)
appTypeint1 cloud3d 2 xR(默认值为1)
roomIdLong房间id
idLongid

返回结果:

字段名类型说明
currentintid
sizeint用户名
totalint查询总数
recordsList应用列表

应用

字段名类型说明
idLong应用Id
nameString应用名称
descriptionString描述
startFlagString"on" 上架,"off" 下架
instanceMaxString最大并发数量
syncStatusString10:同步中 14:发布中 15:覆盖中 16:发布部分成功且同步中 17部分成功部分失败 40:覆盖失败 45:发布失败 20:发布成功
userIdLong用户id
fileSizeString文件大小(单位为字节 )
picUrlString应用缩略图地址
engineTypeInteger引擎类型 1/ue4,unity/2,0/other
type应用类型类型1 3d 2 xr
roomIdLong房间id
concurrencyString当前并发数
gpuConfigIdLong指定机型
machineDesString机型描述
createTimeDate创建时间
updateTimeDate应用时间
sharAppkeyString分享appkey
shareAppSecretString分享AppSecret
shareIdLong分享Id
appShareLinkStringapp分享链接
castScreenAppKeyString投屏appKey
castScreenAppSecretString投屏AppSecret
castScreenShareLinkString投屏分享链接
castScreenShareIdLong投屏的分享id
pushStreamTypeInteger推流方式
showCastScreenUsersInteger是否显示投屏用户列表 0不显示 1显示
publishTimeLocalDateTime发布时间
appPathString应用路径
auditStatusInteger审核状态 0 创建中 1等待审核 2审核中 3 通过 -1 审核不通过 -2审核終止(创建失败或者超时覆盖失败时)
auditIdLong审核id
auditTimeLocalDateTime审核时间

返回内容示例:

{
    "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"
}

查询应用分享列表

请求地址: https://app.3dcat.live/api/3dcat/application/shareApp/list

请求方法:GET

请求参数:

字段名类型是否必填说明
currentint当前页(从1开始)
sizeint一页数目
nameString应用名称(模糊查询)
appTypeint1 cloud3d 2 xR(默认值为1)
roomIdLong房间id
idLongid

返回结果:

字段名类型说明
currentintid
sizeint用户名
totalint查询总数
recordsList应用列表

应用

字段名类型说明
idLong应用Id
nameString应用名称
descriptionString描述
startFlagString"on" 上架,"off" 下架
appTypeString应用类型
instanceMaxString最大并发数量
syncStatusString10:同步中 14:发布中 15:覆盖中 16:发布部分成功且同步中 17部分成功部分失败 40:覆盖失败 45:发布失败 20:发布成功
userIdLong用户id
fileSizeString文件大小(单位为字节 )
picUrlString应用缩略图地址
appShareLinkStringapp分享链接
userNameString用户名称
type应用类型类型1 3d 2 xr
roomIdLong房间id
engineTypeInteger引擎类型 1/ue4,unity/2,0/other
concurrencyString当前并发数
isDeleteInteger是否删除
createTimeLocalDateTime创建时间
updateTimeLocalDateTime应用时间
sharAppkeyString分享appkey
shareIdLong分享Id
gpuConfigIdLong指定机型

返回内容示例:

{
    "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"
}

查询用户所有应用列表

请求地址: https://app.3dcat.live/api/3dcat/application/all

说明:此接口用于应用覆盖时查询该用户所有应用列表接口

请求方法:get

请求参数:

字段名类型是否必填说明
typeint应用类型 1:3d 2:vr 3:全部 默认1
fileIdLong文件id

返回结果:

字段名类型说明
idLong应用Id
nameString应用名称

返回内容示例:

{
    "version": "1.0.0",
    "result": true,
    "message": "success",
    "code": 200,
    "data": [
        {
            "id": 417,
            "name": "3dcat12"
        }
    ],
    "serverTime": 1638779799746,
    "requestId": "9c53d367e9a9bd6e"
}

查询单个应用详情

请求地址: https://app.3dcat.live/api/3dcat/application/{id}/info

说明需将{id}替换成应用id

请求方法:get

请求参数:

字段名类型是否必填说明
idLongid

返回结果:

字段名类型说明
idLong应用Id
nameString应用名称
fileSizeString文件大小
descriptionString描述
appKeyStringappKey
appSecretString分享密钥
paramString应用运行附加参数
appTypeint应用类型 2/共享GPU,1/独占GPU,3/OpenVR
picUrlString应用缩略图地址
instanceMaxString最大并发数
appPathString固定 "/"
exePathString可执行程序路径,应用启动文件名
zipFileString压缩包全名
parentFileString父目录
engineTypeInteger引擎类型 2/unreal,unity/1,0/other
startFlagString"on" 上架,"off" 下架
virtualComponentInteger控制虚拟控件显示 1 (默认),2 ,3 都不显示
roomIdLong房间id
appShareLinkString应用分享链接
shareStartTimeDate链接开始时间
shareEndTimeDate链接结束时间
concurrencyString当前并发数
gpuConfigIdLong指定机型
machineDesString机型描述
keyboardMappingIdLong预设方案id(与键鼠映射配置二选一)
keyboardMappingConfigString键鼠映射配置(与预设方案id二选一)
syncStatusInteger同步状态:14发布中 15覆盖中 16发布部分成功且同步中 17 部分成功部分失败 40 覆盖失败 45 发布失败 20发布成功"
pushStreamTypeInteger推流方式
needPortInteger是否开启端口
settingHoverButtonInteger终端设置悬浮按钮 1/移动端展示 2/pc端展示 3/都显示
inputHoverButtonInteger终端输入悬浮按钮 1/排除端展示
fileIdLong文件id
exePathsList可执行文件列表
onShelfTimeLocalDateTime上架时间
showCastScreenUsersInteger显示投屏用户列表 默认显示0不显示 1显示
castScreenAppShareLinkString应用投屏分享链接
castScreenShareStartTimeDate投屏链接开始时间
castScreenShareEndTimeDate投屏链接结束时间
castScreenAppKeyString投屏应用key
castScreenAppSecretString投屏应用密钥
publishTimeLocalDateTime发布时间
needLandscapeInteger终端默认横屏 移动端
landscapeTypeInteger1/自适应 2/拉伸 3/裁剪
auditStatusInteger审核状态 0 创建中 1等待审核 2审核中 3 通过 -1 审核不通过 -2审核終止(创建失败或者超时覆盖失败时)
openMicrophoneBoolean语音交互 默认不开启
openMultiTouchBoolean多点触控 默认不开启
afkIntegerafk
defaultAfkBoolean是否为默认afk,0/非默认 1/默认
framerateInteger帧率
billMethodInteger计费方式 1/按量计费 2/套餐计费
newsletterTypeInteger云端应用通信角色 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"
}

发布应用

请求地址: https://app.3dcat.live/api/3dcat/application/publish

请求方法: POST

请求参数:

字段名类型是否必填说明
nameString应用名称
fileSizeString应用大小
descriptionString应用描述
instanceMaxint应用最大同时运行数量
paramString启动参数
zipFileString应用程序压缩包全路径名
exePathString可执行程序路径,应用启动文件名(压缩包内的相对路径)
roomIdLong房间id (type 为2时才需要房间)
appTypeint应用类型 2/共享GPU,1/独占GPU (type为1时必传)
imageIdLong图片上传时返回的id(当picUrl有值为必填)
picUrlString应用缩略图地址
pushStreamTypeint推流方式 1/2k 2/4k 3/不限制
settingHoverButtonInteger终端设置悬浮按钮 1/移动端展示 2/pc端展示 3/都显示
inputHoverButtonInteger终端输入悬浮按钮 1/排除端展示
needLandscapeInteger终端默认横屏 移动端
landscapeTypeInteger1/自适应 2/拉伸 3/裁剪
openMicrophoneBoolean语音交互 默认不开启
openMultiTouchBoolean多点触控 默认不开启
afkIntegerafk
defaultAfkBoolean是否为默认afk,0/非默认 1/默认
framerateInteger帧率
gpuConfigIdLong云渲染并发规则

返回结果:

返回内容示例:

{
    "version": "1.0.0",
    "result": true,
    "message": "success",
    "code": 200,
    "data": null,
    "serverTime": 1638779219133,
    "requestId": "07c8df7523329c52"
}

删除应用

请求地址: https://app.3dcat.live/api/3dcat/application/delete/{id}

说明: 请求时替换{id}为应用id

请求方法: delete

请求参数:

字段名类型是否必填说明
idLongid

返回结果:

返回内容示例:

{
    "version": "1.0.0",
    "result": true,
    "message": "success",
    "code": 200,
    "data": null,
    "serverTime": 1638779298047,
    "requestId": "4dbf1ad8d3febd36"
}

编辑应用

请求地址: https://app.3dcat.live/api/3dcat/application/update

请求方法: POST

请求参数:

字段名类型是否必填说明
idLong应用id
appTypeint应用类型 2/共享GPU,1/独占GPU (type为1时必传)
nameString应用名称
descriptionString描述
instanceMaxString最大并发数量
paramString应用运行附加参数
roomIdLong房间id (type 为2时才需要房间)
exePathString可执行程序路径,应用启动文件名
picUrlString应用缩略图地址
imageIdLong图片上传时返回的id(当picUrl有值为必填)
engineTypeint引擎类型 2/unreal,unity/1,0/other
virtualComponentint控制虚拟控件显示 1 (默认),2 ,3 都不显示 (type为1时必传)
pushStreamTypeInteger推流方式 1/2k 2/4k 3/不限制
needPortInteger是否开启终端与云端应用通信
settingHoverButtonInteger终端设置悬浮按钮 1/移动端展示 2/pc端展示 3/都显示
inputHoverButtonInteger终端输入悬浮按钮 1/排除端展示
needLandscapeInteger终端默认横屏 移动端
landscapeTypeInteger1/自适应 2/拉伸 3/裁剪
openMicrophoneBoolean语音交互 默认不开启
openMultiTouchBoolean多点触控 默认不开启
afkIntegerafk
defaultAfkBoolean是否为默认afk,0/非默认 1/默认
framerateInteger帧率
newsletterTypeInteger云端应用通信角色 1/客户端 2/服务端
gpuConfigIdInteger云渲染并发规则
needPortInteger是否开启终端与云端应用通信

返回结果:

返回内容示例:

{
    "version": "1.0.0",
    "result": true,
    "message": "success",
    "code": 200,
    "data": null,
    "serverTime": 1638779153077,
    "requestId": "b789be497b7deae9"
}

覆盖应用

请求地址: https://app.3dcat.live/api/3dcat/application/cover

请求方法: POST

请求参数:

字段名类型是否必填说明
idLong应用id
zipFileString用于更新的资产压缩包名称
exePathString可执行程序路径,应用启动文件名
appTypeint应用类型 2/共享GPU,1/独占GPU (type为1时必传)
nameString应用名称
fileSizeString文件大小(单位为字节)
descriptionString描述
instanceMaxString最大并发数量
exeParamString启动参数
engineTypeint引擎类型 2/unreal,unity/1,0/other
roomIdLong房间id (type 为2时才需要房间)
imageIdLong图片上传时返回的id(当picUrl有值为必填)
picUrlString应用缩略图地址
virtualComponentint控制虚拟控件显示 1 (默认),2 ,3 都不显示 (type为1时必传)
pushStreamTypeInteger推流方式 1/2k 2/4k 3/不限制
showCastScreenUsersInteger显示投屏用户列表0不显示 1显示
settingHoverButtonInteger端设置悬浮按钮 1/移动端展示 2/pc端展示 3/都显示
inputHoverButtonInteger终端输入悬浮按钮 1/排除端展示
needLandscapeInteger终端默认横屏 移动端
landscapeTypeInteger1/自适应 2/拉伸 3/裁剪
openMicrophoneBoolean语音交互 默认不开启
openMultiTouchBoolean多点触控 默认不开启
afkIntegerafk
gpuConfigIdLong云渲染并发规则

返回结果:

返回内容示例:

{
    "version": "1.0.0",
    "result": true,
    "message": "success",
    "code": 200,
    "data": null,
    "serverTime": 1638779451365,
    "requestId": "da2832600c9ab932"
}

上下架应用

请求地址: https://app.3dcat.live/api/3dcat/application/changeShelfStatus

请求方法: put

请求参数:

字段名类型是否必填说明
idLong应用id
statusString"on":上架 "off":下架

返回结果:

返回内容示例:

{
    "version": "1.0.0",
    "result": true,
    "message": "success",
    "code": 200,
    "data": null,
    "serverTime": 1637812904201,
    "requestId": "560055f1bd6f5f3f"
}

更新应用房间号

请求地址: https://app.3dcat.live/api/3dcat/application/updateRoom

请求方法: put

请求参数:

字段名类型是否必填说明
idLong应用id
roomIdLong房间id

返回结果:

返回内容示例:

{
    "version": "1.0.0",
    "result": true,
    "message": "success",
    "code": 200,
    "data": null,
    "serverTime": 1638780466697,
    "requestId": "e044554eaac6c345"
}

重置覆盖失败的应用

请求地址: https://app.3dcat.live/api/3dcat/application/resetCover

请求方法: put

请求参数:

字段名类型是否必填说明
idLong应用id

返回结果:

返回内容示例:

{
    "version": "1.0.0",
    "result": true,
    "message": "success",
    "code": 200,
    "data": null,
    "serverTime": 1638780387512,
    "requestId": "1194fc0cedd0e132"
}

修改应用启动的机型

请求地址: https://app.3dcat.live/api/3dcat/application/modify/gpuPriceConfig

请求方法: put

请求参数:

字段名类型是否必填说明
appIdLong应用id
gpuIdLong机型id

返回结果:

返回内容示例:

{
    "version": "1.0.0",
    "result": true,
    "message": "success",
    "code": 200,
    "data": null,
    "serverTime": 1638780387512,
    "requestId": "1194fc0cedd0e132"
}

设置应用键鼠映射

请求地址: https://app.3dcat.live/api/3dcat/application/update/keyboardMapping

请求方法: put

请求参数:

字段名类型是否必填说明
appIdLong应用id
keyboardMappingIdLong预设方案id(与键鼠映射配置二选一)
keyboardMappingConfigString键鼠映射配置(与预设方案id二选一)

返回结果:

返回内容示例:

{
    "version": "1.0.0",
    "result": true,
    "message": "success",
    "code": 200,
    "data": null,
    "serverTime": 1638780743710,
    "requestId": "9288bf29d32295f7"
}

查询审核信息

请求地址: https://app.3dcat.live/api/3dcat/application/auditDetail

请求方法: Get

请求参数:

字段名类型是否必填说明
idLong审核Id

返回结果:

字段名类型说明
idLongid
appIdString应用id
auditStatusString审核状态 0 创建中 1等待审核 2审核中 3 通过 -1 审核不通过 -2审核終止(创建失败或者超时覆盖失败时)
auditReasonString审核理由
createTimeLocalDateTime创建时间
updateTimeLocalDateTime更新时间

返回内容示例:

{
	"code": 0,
	"data": {
		"appId": 0,
		"auditReason": "",
		"auditStatus": 0,
		"createTime": "",
		"id": 0,
		"updateTime": ""
	},
	"message": "",
	"requestId": "",
	"result": true,
	"serverTime": 0,
	"version": ""
}

应用启动

请求地址: https://app.3dcat.live/api/3dcat/application/start

请求地址: https://app.3dcat.live/api/3dcat/application/vr/app/start

请求方法:POST

请求参数:

字段名类型是否必填说明
appIdLong应用id
bitrateInteger码率
framerateInteger帧率
videoGopIntervalInteger关键帧间隔
typeStringrayvision,CloudXR 默认rayvision
protocolStringtcp,udp 默认udp
exeParameterString应用启动参数
clientIpString客户端ip
platformIdInteger平台ip
screencastPwdString投屏密码
screencastMaxConcurrencyInteger投屏最大并发
shareIdLong分享id
optionalParamStringoptionalParam
joinTypeInteger投屏专享 加入方式 1 口令 2链接
externalPortBoolean是否为外部端口

返回结果:

返回内容示例:

{
	"code": 0,
	"data": "",
	"message": "",
	"requestId": "",
	"result": true,
	"serverTime": 0,
	"version": ""
}

获取应用播放链接

请求地址: https://app.3dcat.live/api/3dcat/application/playerUrl

请求方法:Get

请求参数:

字段名类型是否必填说明
appKeyStringappKey
appSecretString链接密码
castScreenPwdString投屏密码
castScreenNicknameString投屏昵称
castScreenMaxQtyInteger并发数
isCastScreenMasterBoolean是否是主控端
platformInteger平台号
isMirrorInteger是否镜像
clientIpString客户端ip
minBitrateInteger最小码率
maxBitrateInteger最大码率
startBitrateInteger初始码率
optionalParamString自定义动态参数
joinTypeInteger加入方式
externalPortBoolean是否为外部端口

返回结果:

返回内容示例:

{
    "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"
}
业务咨询:400-8037-298