# API接口列表
# 应用
# 修改应用
# 基本信息
Path: /open/v1/app/edit
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
app_no | text | 是 | 要修改的应用id | |
name | text | 否 | 应用名称 | |
app_code | text | 否 | 应用唯一码 | |
path | text | 否 | 应用启动进程完整路径 | |
view_process | text | 否 | 应用视图进程完整路径 | |
args | text | 否 | 应用启动参数 | |
app_mode_id | text | 否 | 应用模板id |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 非必须 | 数据 | ||
msg | string | 非必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {},
"msg": "操作成功"
}
# 返回示例
{
"code": 201,
"data": {},
"msg": "操作失败"
}
# 删除应用
# 基本信息
Path: /open/v1/app/del
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
app_no | text | 是 | 要删除的应用id |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 非必须 | 数据 | ||
msg | string | 非必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {},
"msg": "操作成功"
}
# 返回示例
{
"code": 201,
"data": {},
"msg": "数据不存在或已删除,请刷新后重试"
}
# 应用列表
# 基本信息
Path: /open/v1/app/index
Method: GET
接口描述:
# 请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 否 | 10 | 每页返回数据条数,默认10条 |
page | 否 | 1 | 当前请求的页码 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 非必须 | 数据 | ||
├─ page_no | number | 非必须 | 当前页码 | ||
├─ page_total | number | 非必须 | 总页数 | ||
├─ result | object [] | 非必须 | 数据列表 | item 类型: object | |
├─ app_no | string | 必须 | 应用id | ||
├─ name | string | 必须 | 应用名称 | ||
├─ app_code | string | 必须 | 应用识别码 | ||
├─ path | string | 必须 | 应用启动完整路径 | ||
├─ view_process | string | 必须 | 应用视图进程完整路径 | ||
├─ is_desk | number | 必须 | 是否是桌面模式 1 是 2 否 | ||
├─ create_time | string | 必须 | 创建时间 | ||
├─ update_time | string | 必须 | 更新时间 | ||
├─ app_mode_no | string | 必须 | 所属应用模板编号 | ||
├─ cate_name | string | 必须 | 所属应用分组,空字符代表未分组 | ||
├─ computer_no | string | 必须 | 所属服务器id,空代表未分配服务器 | ||
├─ computer_name | string | 必须 | 所属服务器名称,空字符代表未分配服务器 | ||
├─ ip | string | 必须 | 所属服务器ip,空代表未分配服务器 | ||
├─ app_cate_no | string | 非必须 | 所属应用分组id,空字符串代表未设置分组 | ||
├─ total | number | 非必须 | |||
msg | string | 非必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"page_no": 1,
"page_total": 67,
"result": [
{
"app_no": "827c43fc37dc40e39d519027bbb0b5b2",
"name": "记事本111",
"app_code": "asdasd",
"path": "ccc",
"view_process": "ccc1",
"args": "args",
"is_desk": 2,
"mark": "",
"create_time": "2022-01-07T15:59:20+08:00",
"update_time": "2022-01-08T16:47:19+08:00",
"app_mode_no": "5d333cf62497f2115908007cfd754834",
"app_cate_no": "",
"computer_no": "ebcb4c6cde0e116bd4771b2e17a57f9b",
"computer_name": "西北",
"cate_name": "",
"ip": "39.91.33.96"
},
{
"app_no": "88f08d27f7e0721ad7418861a6954bdb",
"name": "记事本",
"app_code": "121211",
"path": "C:\\Windows\\system32\\mspaint.exe",
"view_process": "1111sad",
"args": "",
"is_desk": 2,
"mark": "",
"create_time": "2022-01-06T10:07:03+08:00",
"update_time": "2022-01-06T16:04:08+08:00",
"app_mode_no": "f062b88100d7956a62db1bd6dc5d980f",
"app_cate_no": "",
"computer_no": "b9ec19fd82dfcaacd4480bdfb1bc1b18",
"computer_name": "10.0.0.172",
"cate_name": "",
"ip": "10.0.0.172"
}
],
"total": 133
},
"msg": "获取成功"
}
# 应用详情
# 基本信息
Path: /open/v1/app/detail
Method: GET
接口描述:
# 请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
app_no | 是 | 应用id,可通过应用列表接口获取 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | 数据 | ||
├─ app_no | string | 必须 | 应用id | ||
├─ computer_no | string | 必须 | 所属服务器id,空代表未分配服务器 | ||
├─ name | string | 必须 | 应用名称 | ||
├─ app_code | string | 必须 | 应用识别码 | ||
├─ path | string | 必须 | 应用启动完整路径 | ||
├─ view_process | string | 必须 | 应用视图进程完整路径 | ||
├─ is_desk | number | 必须 | 是否是桌面模式 1 是 2 否 | ||
├─ create_time | string | 必须 | 创建时间 | ||
├─ update_time | string | 必须 | 更新时间 | ||
必须 | 所属应用模板id | ||||
├─ app_mode_no | string | 必须 | 所属应用模板编号 | ||
├─ cate_name | string | 必须 | 所属应用分组,空字符代表未分组 | ||
├─ computer_name | string | 必须 | 所属服务器名称,空字符代表未分配服务器 | ||
├─ ip | string | 必须 | 所属服务器ip,空代表未分配服务器 | ||
├─ app_cate_no | string | 必须 | 所属应用分组id,空代表未设置分组 | ||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"app_no": "88f08d27f7e0721ad7418861a6954bdb",
"name": "记事本",
"app_code": "121211",
"path": "C:\\Windows\\system32\\mspaint.exe",
"view_process": "1111sad",
"args": "",
"is_desk": 2,
"mark": "",
"create_time": "2022-01-06T10:07:03+08:00",
"update_time": "2022-01-06T16:04:08+08:00",
"app_mode_no": "f062b88100d7956a62db1bd6dc5d980f",
"app_cate_no": "da667cee490767f33a3959dab25d4fec",
"computer_no": "b9ec19fd82dfcaacd4480bdfb1bc1b18",
"computer_name": "10.0.0.172",
"cate_name": "测试分类",
"ip": "10.0.0.172"
},
"msg": "获取成功"
}
# 添加应用
# 基本信息
Path: /open/v1/app/add
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
name | text | 是 | mspaint | 应用名称eg:记事本 |
app_mode_no | text | 是 | 应用模板id,可使用应用模板列表接口获取应用模板 | |
app_code | text | 否 | mspaint | 应用识别码,可自由设置或者省略由系统生成,可用来调度不同服务器的同一类应用 |
path | text | 是 | C:\Windows\system32\mspaint.exe | 应用安装的全路径 |
view_process | text | 是 | C:\Windows\system32\mspaint.exe | UE的应用往往视图进程与启动进程不一致,此时需单独设置,否则与path保持一致即可 |
args | text | 否 | -start=1 | 应用启动需要的参数,默认留空 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | 态码,200代表成功,非200代表失败 | ||
data | object | 非必须 | 数据 | ||
├─ app_no | string | 非必须 | 应用id | ||
msg | string | 非必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"app_no": "827c43fc37dc40e39d519027bbb0b5b2"
},
"msg": "添加成功"
}
# 应用分组
# 获取应用分组
# 基本信息
Path: /open/v1/app_cate/index
Method: GET
接口描述:
# 请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 是 | 10 | 每页返回数据条数,默认10条 |
page | 是 | 1 | 当前请求的页码 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
├─ page_no | number | 必须 | |||
├─ page_total | number | 必须 | |||
├─ result | object [] | 必须 | item 类型: object | ||
├─ app_cate_no | string | 必须 | 应用分组id | ||
├─ name | string | 必须 | 应用分组名 | ||
├─ app_type | number | 必须 | 应用类型(关联应用后自动绑定生成) 1app 2 game | ||
├─ create_time | string | 必须 | 创建时间 | ||
├─ update_time | string | 必须 | 更新时间 | ||
├─ total | number | 必须 | |||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"page_no": 1,
"page_total": 5,
"result": [
{
"app_cate_no": "5295ab3a-cdeb-491e-b8c6-cac5652127c5",
"name": "111测试",
"app_type": 1,
"create_time": "2022-01-07T13:56:03+08:00",
"update_time": "2022-01-08T16:03:10+08:00"
},
{
"app_cate_no": "a272f998a1e54c27354994fbd3392d46",
"name": "测试分类",
"app_type": 1,
"create_time": "2021-12-20T17:24:21+08:00",
"update_time": "2021-12-20T17:24:21+08:00"
},
],
"total": 43
},
"msg": "获取成功"
}
# 添加应用分组
# 基本信息
Path: /open/v1/app_cate/add
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
name | text | 是 | 应用分组名称 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 非必须 | |||
├─ app_cate_no | string | 非必须 | 应用分组id | ||
msg | string | 非必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"app_cate_no": "17698a16787f461a9d71d2918667d631"
},
"msg": "添加成功"
}
# 修改应用分组
# 基本信息
Path: /open/v1/app_cate/edit
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
app_cate_no | text | 是 | 应用分组id | |
name | text | 否 | 新的分组名 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 非必须 | 数据 | ||
msg | string | 非必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {},
"msg": "操作成功"
}
# 删除应用分组
# 基本信息
Path: /open/v1/app_cate/del
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
app_cate_no | text | 是 | 应用分组id |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 非必须 | |||
msg | string | 非必须 | 状态信息 |
成功:
{
"code": 200,
"data": {},
"msg": "操作成功"
}
失败:
{
"code": 201,
"data": {},
"msg": "当前数据不存在,请刷新后重试"
}
# 修改应用分组的授权地址
# 基本信息
Path: /open/v1/app_cate/temp_edit
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
app_cate_temp_no | text | 是 | 应用分组的授权地址id | |
phone | text | 否 | 手机号 | |
username | text | 否 | 用户名 | |
minute | text | 否 | 1440 | 有效时间 |
mark | text | 否 | 备注 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {},
"msg": "操作成功"
}
# 应用分组的授权地址列表
# 基本信息
Path: /open/v1/app_cate/temp_list
Method: GET
接口描述:
# 请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
page | 否 | 1 | 当前请求的页码 |
limit | 否 | 10 | 每页返回数据条数,默认10条 |
app_cate_no | 是 | 应用分组id | |
is_auto_create | 否 | 如果当前应用分组没有授权地址,是否自动添加 0:不自动创建 1:自动创建 默认0 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 非必须 | 数据 | ||
├─ page_no | integer | 非必须 | 页码 | ||
├─ page_total | integer | 非必须 | 总页数 | ||
├─ result | object [] | 非必须 | 数据结果 | item 类型: object | |
├─ app_cate_user_no | string | 非必须 | 授权地址id | ||
├─ username | string | 非必须 | 用户名 | ||
├─ phone | string | 非必须 | 手机号 | ||
├─ minute | number | 非必须 | 有效期(分钟数) | ||
├─ delay | number | 非必须 | 最好一次延期分钟数 | ||
├─ token | string | 非必须 | token | ||
├─ create_time | string | 非必须 | 创建时间 | ||
├─ update_time | string | 非必须 | 更新时间 | ||
├─ online_duration | number | 非必须 | 在线时长 | ||
├─ use_num | number | 非必须 | 使用次数 | ||
├─ type | number | 非必须 | token类型 0 主控允许旁观 1 主控不允许旁观 0 主控允许旁观 1 主控不允许旁观 2 该token仅允许旁观 | ||
├─ url | string | 非必须 | |||
├─ android_url | string | 非必须 | web地址访问url | ||
├─ total | number | 非必须 | 安卓地址访问url | ||
msg | string | 非必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"page_no": 1,
"page_total": 1,
"result": [
{
"app_cate_user_no": "6a990eb5c3d444e09394e6bf58e66d81",
"username": "auto api",
"phone": "apiUser1641628922",
"minute": 43200,
"delay": 0,
"mark": "自动创建",
"token": "f8ae54af1dc0b372b484c56ad889f69f",
"create_time": "2022-01-08T16:02:03+08:00",
"update_time": "2022-01-08T16:02:03+08:00",
"online_duration": 0,
"use_num": 0,
"type": 0,
"app_cate_no": 0,
"url": "http://app.dolit.cloud/app?info=xxxxxxx",
"android_url": "dlca://streamer?cate_id=402&app_key=xx812f2b3f1a254421d829161f0493ac&token=f8ae54af1dc0b372b484c56ad889f69f"
}
],
"total": 1
},
"msg": "获取成功"
}
# 延期应用分组的授权地址
# 基本信息
Path: /open/v1/app_cate/tempDelay
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
app_cate_temp_no | text | 是 | 应用分组的授权地址id | |
delay | text | 是 | 1000 | 延期的分钟数 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {},
"msg": "延期成功"
}
# 添加应用分组的授权地址
# 基本信息
Path: /open/v1/app_cate/add_temp
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
app_cate_no | text | 是 | 应用分组id | |
phone | text | 否 | 手机号(登录获取验证码用) | |
username | text | 否 | 用户名 | |
minute | text | 否 | 1440 | 有效时间(分钟) |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
├─ app_cate_temp_no | integer | 必须 | 应用分组的授权地址id | ||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"app_cate_temp_no": "d65fd78f9d5f49e294572d65278d768d"
},
"msg": "添加成功"
}
# 应用模板
# 添加应用模板
# 基本信息
Path: /open/v1/app_mode/add
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 | ||
Body |
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
mode_name | text | 是 | 模板名称 | |
app_type | text | 否 | 应用类型 1:app 2:game | |
app_mark | text | 否 | 备注 | |
mouse_type | text | 是 | 1相对定位(普通模式下支持右键拖曳的兼容模式) 2绝对定位 3 远端相对定位(runType=box) | |
is_check_online | text | 是 | 没有人连接的时候是否自动关闭流路,1开启,2关闭 | |
is_open_ue_plugin_args | text | 是 | 是否启动ue插件参数。1 开启 2 关闭 默认 关闭 (对接了ue消息插件的ue类型应用可以选择开启) | |
capture | text | 是 | 截取模式 1:内置2:通用 | |
mode | text | 是 | 运行方式 1 容器2 沙盒3. 极速沙盒4. 云桌面 5.独显沙盒 | |
win_multiple | text | 否 | 是否禁止开启多窗口捕获,1是,2否 mode为1的情况下有效 | |
pic_cut | text | 否 | 否应用内截取画面,1是,2否 mode为1的情况下有效 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
├─ app_mode_no | number | 必须 | 应用模板id | ||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"app_mode_no": "4d7f645a768024e2133e9ae61e2f3a30"
},
"msg": "添加成功"
}
# 删除应用模板
# 基本信息
Path: /open/v1/app_mode/del
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
sign | text | 是 | ||
app_mode_no | text | 是 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {},
"msg": "操作成功"
}
# 编辑应用模板
# 基本信息
Path: /open/v1/app_mode/edit
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
app_mode_no | text | 是 | 要修改的应用模板id | |
mode_name | text | 否 | 模板名称 | |
app_type | text | 否 | 应用类型 1:app 2:game | |
app_mark | text | 否 | 备注 | |
mouse_type | text | 否 | 1相对定位(普通模式下支持右键拖曳的兼容模式) 2绝对定位 3 远端相对定位(runType=box) | |
is_check_online | text | 否 | 没有人连接的时候是否自动关闭流路,1开启,2关闭 | |
is_open_ue_plugin_args | text | 否 | 是否启动ue插件参数。1 开启 2 关闭 默认 关闭 (对接了ue消息插件的ue类型应用可以选择开启) | |
capture | text | 否 | 截取模式 1:内置2:通用 | |
mode | text | 否 | 运行方式 1 容器2 沙盒3. 极速沙盒4. 云桌面 5.独显沙盒 | |
win_multiple | text | 否 | 是否禁止开启多窗口捕获,1是,2否 mode为1的情况下有效 | |
pic_cut | text | 否 | 否应用内截取画面,1是,2否 mode为1的情况下有效 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {},
"msg": "操作成功"
}
# 获取应用模板
# 基本信息
Path: /open/v1/app_mode/index
Method: GET
接口描述:
# 请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
page | 否 | 1 | 当前请求的页码 |
limit | 否 | 10 | 每页返回数据条数,默认10条 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
├─ page_no | number | 必须 | |||
├─ page_total | number | 必须 | |||
├─ result | object [] | 必须 | item 类型: object | ||
├─ mode_name | string | 必须 | 模板名称 | ||
├─ addtime | string | 必须 | 添加时间 | ||
├─ app_mode_no | string | 必须 | 模板编号 | ||
├─ is_desk | integer | 必须 | 是否是桌面模式,1是,2不是 | ||
├─ app_type | integer | 必须 | 应用类型 1:app 2:game | ||
├─ is_check_online | integer | 必须 | 没有人连接的时候是否自动关闭流路,1开启,2关闭 | ||
├─ check_online_interval | integer | 必须 | 没有人连接的时候自动关闭流路的缓冲时间(单位:秒) | ||
├─ mouse_type | integer | 必须 | 相对定位(普通模式下支持右键拖曳的兼容模式) 2绝对定位 3 远端相对定位(runType=box) | ||
├─ win_multiple | integer | 必须 | 是否禁止开启多窗口捕获,1是,2否 | ||
├─ pic_cut | integer | 必须 | 是否应用内截取画面,1是,2否 | ||
├─ capture | integer | 必须 | 截取模式 1:内置2:通用 | ||
├─ mode_type | integer | 必须 | 模板类型:1总平台添加,2自己添加 | ||
├─ audio_capture | integer | 必须 | 音频模型: 1 声卡模式 2 内置模式 | ||
├─ is_open_ue_plugin_args | integer | 必须 | 是否启动ue插件参数。1 开启 2 关闭 默认 关闭 (对接了ue消息插件的ue类型应用可以选择开启) | ||
├─ container_type | integer | 必须 | 虚拟化方式 1 多会话 rdp2 单控制台沙盒 3 多离线会话独立沙盒 | ||
├─ mode | integer | 必须 | 运行方式 1 容器2 沙盒3. 极速沙盒4. 云桌面 5.独显沙盒 | ||
├─ total | integer | 必须 | |||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"page_no": 2,
"page_total": 5,
"result": [
{
"mode_name": "console",
"create_time": "2021-12-25T11:53:41+08:00",
"app_mode_no": "9873193607537df53bad37cec2cf7632",
"is_desk": 2,
"app_type": 2,
"is_check_online": 2,
"check_online_interval": 10,
"mouse_type": 1,
"win_multiple": 1,
"pic_cut": 1,
"capture": 1,
"mode_type": 2,
"audio_capture": 2,
"is_open_ue_plugin_args": 2,
"container_type": 2,
"mode": 5
}
],
"total": 25
},
"msg": "获取成功"
}
# 获取总平台应用模板
# 基本信息
Path: /open/v1/app_mode/mode_base
Method: GET
接口描述:
# 请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
page | 否 | 1 | 当前请求的页码 |
limit | 否 | 10 | 每页返回数据条数,默认10条 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
├─ page_no | number | 必须 | |||
├─ page_total | number | 必须 | |||
├─ result | object [] | 必须 | item 类型: object | ||
├─ mode_name | string | 必须 | 模板名称 | ||
├─ addtime | string | 必须 | 添加时间 | ||
├─ mode_no | string | 必须 | 模板编号 | ||
├─ is_desk | number | 必须 | 是否是桌面模式,1是,2不是 | ||
├─ app_type | number | 必须 | 应用类型 1:app 2:game | ||
├─ is_check_online | number | 必须 | 没有人连接的时候是否自动关闭流路,1开启,2关闭 | ||
├─ check_online_interval | number | 必须 | 没有人连接的时候自动关闭流路的缓冲时间(单位:秒) | ||
├─ mouse_type | number | 必须 | 相对定位(普通模式下支持右键拖曳的兼容模式) 2绝对定位 3 远端相对定位(runType=box) | ||
├─ win_multiple | number | 必须 | 是否禁止开启多窗口捕获,1是,2否 | ||
├─ pic_cut | number | 必须 | 是否应用内截取画面,1是,2否 | ||
├─ capture | number | 必须 | 截取模式 1:内置2:通用 | ||
├─ mode_type | number | 必须 | 模板类型:1总平台添加,2自己添加 | ||
├─ audio_capture | number | 必须 | 音频模型: 1 声卡模式 2 内置模式 | ||
├─ is_open_ue_plugin_args | number | 必须 | 是否启动ue插件参数。1 开启 2 关闭 默认 关闭 (对接了ue消息插件的ue类型应用可以选择开启) | ||
├─ container_type | number | 必须 | 虚拟化方式 1 多会话 rdp2 单控制台沙盒 3 多离线会话独立沙盒 | ||
├─ mode | number | 必须 | 运行方式 1 容器2 沙盒3. 极速沙盒4. 云桌面 5.独显沙盒 | ||
├─ total | number | 必须 | |||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"page_no": 2,
"page_total": 5,
"result": [
{
"mode_name": "console",
"create_time": "2021-12-25T11:53:41+08:00",
"app_mode_no": "9873193607537df53bad37cec2cf7632",
"is_desk": 2,
"app_type": 2,
"is_check_online": 2,
"check_online_interval": 10,
"mouse_type": 1,
"win_multiple": 1,
"pic_cut": 1,
"capture": 1,
"mode_type": 2,
"audio_capture": 2,
"is_open_ue_plugin_args": 2,
"container_type": 2,
"mode": 5
}
],
"total": 25
},
"msg": "获取成功"
}
# 流路
# 添加流路
# 基本信息
Path: /open/v1/streamer/add
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 | ||
Body |
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
computer_no | text | 是 | 服务器id | |
end_date | text | 是 | 2022-12-30 | 流路到期时间 |
app_no | text | 是 | 应用id | |
open_audio | text | 否 | 1 | 是否开启音频 1 开启 2 不开启 |
bitrate | text | 否 | 8 | 码率 |
verify_type | text | 否 | 1 | 访问方式 1 token访问2,临时密码,3短信验证 |
protocol | text | 否 | 1 | 协议类型 1:http 2:https 目前只支持1 |
url_password | text | 否 | url访问密码 verify_type为2时有效 | |
view_max_count | text | 否 | 0 | 旁观排队人数,0为不限人数 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
├─ streamer_no | string | 必须 | 流路id | ||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"streamer_no": "88ec5a4a9bac4b0bb6c2c7a73a6cc92f"
},
"msg": "流路添加成功"
}
# 修改流路
# 基本信息
Path: /open/v1/streamer/edit
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
streamer_no | text | 是 | 要修改的流路id | |
computer_no | text | 是 | 服务器id | |
end_date | text | 是 | 2022-12-30 | 流路到期时间 |
app_id | text | 是 | 应用id | |
open_audio | text | 否 | 1 | 是否开启音频 1 开启 2 不开启 |
bitrate | text | 否 | 10 | 码率 |
verify_type | text | 否 | 1 | 访问方式 1 token访问2,临时密码,3短信验证 |
url_password | text | 否 | url访问密码 verify_type为2时有效 | |
protocol | text | 否 | 1 | 协议类型 1:http 2:https 目前只支持1 |
fps | text | 否 | 30 | 帧率 |
view_max_count | text | 否 | 0 | 旁观排队人数,0为不限人数 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 非必须 | |||
msg | string | 非必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {},
"msg": "修改成功"
}
# 关闭流路
# 基本信息
Path: /open/v1/streamer/stop_cloud_app
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
streamer_no | text | 是 | 要关闭的流路id |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {},
"msg": "停止成功"
}
# 删除流路
# 基本信息
Path: /open/v1/streamer/del
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
streamer_no | text | 是 | 要删除的流路id |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {},
"msg": "删除成功"
}
# 启动流路
# 基本信息
Path: /open/v1/streamer/start_cloud_app
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
streamer_no | text | 是 | 流路id |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | 数据 | ||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {},
"msg": "启动成功"
}
# 流路充值或延期
# 基本信息
Path: /open/v1/streamer/recharge
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
streamer_no | text | 是 | 要延期的流路id | |
end_date | text | 是 | 2022-12-30 | 新的过期时间 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | 数据 | ||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {},
"msg": "延期成功"
}
# 流路列表
# 基本信息
Path: /open/v1/streamer/index
Method: GET
接口描述:
# 请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
page | 否 | 1 | 当前请求的页码 |
limit | 否 | 10 | 每页返回数据条数,默认10条 |
is_flush_online_client | 否 | 0 | 是否强制刷新流路在线状态 |
cpu_id | 否 | 服务器id | |
app_code | 否 | 应用唯一码 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
├─ page_no | number | 必须 | |||
├─ page_total | number | 必须 | |||
├─ result | object [] | 必须 | item 类型: object | ||
├─ streamer_no | string | 必须 | 流路id | ||
├─ computer_no | string | 必须 | 服务器id | ||
├─ status | number | 必须 | 在线状态 1在线 0 不在线 | ||
├─ create_time | string | 必须 | 创建时间 | ||
├─ end_time | string | 必须 | 到期时间 | ||
├─ update_time | string | 必须 | 更新时间 | ||
├─ app_no | string | 必须 | 应用id | ||
├─ client_port | number | 必须 | 串流服务端口号 | ||
├─ device_id | string | 必须 | 设置id | ||
├─ password | string | 必须 | 流路密码 | ||
├─ fps | number | 必须 | 帧率 | ||
├─ bitrate | number | 必须 | 码率 | ||
├─ audio_device | string | 必须 | 音频设置名 | ||
├─ open_audio | number | 必须 | 是否开启音频 | ||
├─ protocol | number | 必须 | 协议 1 http 2 https | ||
├─ memo | string | 必须 | 备注 | ||
├─ verify_type | number | 必须 | 验证类型 1token验证,2,临时密码,3短信验证 | ||
├─ url_password | string | 必须 | 访问密码 verify_type=2的时候有效 | ||
├─ computer_name | string | 必须 | 服务器名称 | ||
├─ app_name | string | 必须 | 应用名称 | ||
├─ ip | string | 必须 | 服务器ip | ||
├─ web_cloud_port | number | 必须 | web服务端口号 | ||
├─ guard_port | number | 必须 | 调度服务端口号 | ||
├─ container_type | number | 必须 | 虚拟化方式 1 多会话 rdp2 单控制台沙盒 3 多离线会话独立沙盒 | ||
├─ streamer_key | string | 必须 | 流路key | ||
├─ active_client_count | number | 必须 | 在线客户端数量,请求参数is_flush_online_client=1的时候有效 | ||
├─ is_online | boolean | 必须 | 是否在线,请求参数is_flush_online_client=1的时候有效 | ||
├─ total | number | 必须 | |||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"page_no": 1,
"page_total": 6,
"result": [
{
"streamer_no": "d852a28d-7195-4940-941d-af68b1fe202a",
"status": 0,
"create_time": "2022-01-07T13:57:13+08:00",
"end_time": "2022-12-30T23:59:59+08:00",
"update_time": "2022-01-08T09:49:44+08:00",
"client_port": 10717,
"device_id": "f640c6b3bd2a75c5bd13b3aeb52938c3",
"password": "w1WhPQ18qWF1G4",
"fps": 60,
"bitrate": 12,
"audio_device": "Line 1 (Virtual Audio Cable)",
"open_audio": 2,
"protocol": 1,
"memo": "",
"verify_type": 1,
"url_password": "1234",
"app_no": "455ad269f52213204a5353f62fde2b92",
"computer_no": "4326ee3224092ec41bf715f604e501b8",
"computer_name": "10.0.0.135",
"app_name": "画图板",
"ip": "10.0.0.135",
"web_cloud_port": 9000,
"guard_port": 8050,
"container_type": 1,
"streamer_key": "8efa6b9bdcf53503425063c6b39d8f39",
"active_client_count": 0,
"is_online": false
},
{
"streamer_no": "e14563cb52e39b8372d3e2de52d8a3cc",
"status": 0,
"create_time": "2022-01-05T17:31:32+08:00",
"end_time": "2022-12-30T23:59:59+08:00",
"update_time": "2022-01-05T17:58:17+08:00",
"client_port": 10716,
"device_id": "ee41b41a5367ad8dc69ef74f1de7930c",
"password": "M75RMHffLF6Lbe",
"fps": 60,
"bitrate": 12,
"audio_device": "Line 1 (Virtual Audio Cable)",
"open_audio": 2,
"protocol": 1,
"memo": "",
"verify_type": 1,
"url_password": "1234",
"app_no": "455ad269f52213204a5353f62fde2b92",
"computer_no": "4326ee3224092ec41bf715f604e501b8",
"computer_name": "10.0.0.135",
"app_name": "画图板",
"ip": "10.0.0.135",
"web_cloud_port": 9000,
"guard_port": 8050,
"container_type": 1,
"streamer_key": "ea9acf6971183c28da8d4f0f1966c8bb",
"active_client_count": 0,
"is_online": false
}
],
"total": 12
},
"msg": "获取成功"
}
# 服务器区域
# 添加服务器区域
# 基本信息
Path: /open/v1/computer_area/add
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 | ||
Body |
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
name | text | 是 | 服务器区域名称 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
├─ computer_cate_no | string | 必须 | 服务器区域id | ||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"computer_cate_no": "c6e8327e154741819fee8bae2e54ea44"
},
"msg": "添加成功"
}
# 修改服务器区域
# 基本信息
Path: /open/v1/computer_area/edit
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
computer_cate_no | text | 是 | 要修改的服务器区域id | |
name | text | 否 | 服务器区域名称 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | 数据 | ||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {},
"msg": "操作成功"
}
# 删除服务器区域
# 基本信息
Path: /open/v1/computer_area/del
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
computer_cate_no | text | 是 | 要删除的服务器区域id |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 非必须 | |||
msg | string | 非必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {},
"msg": "删除成功"
}
# 获取服务器区域列表
# 基本信息
Path: /open/v1/computer_area/index
Method: GET
接口描述:
# 请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
page | 否 | 1 | 当前请求的页码 |
limit | 否 | 10 | 每页返回数据条数,默认10条 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
├─ page_no | number | 必须 | |||
├─ page_total | number | 必须 | |||
├─ result | object [] | 必须 | item 类型: object | ||
├─ computer_cate_no | string | 必须 | 服务器区域id | ||
├─ name | string | 必须 | 服务器区域名称 | ||
├─ create_time | string | 必须 | 创建时间 | ||
├─ update_time | string | 必须 | 更新时间 | ||
├─ total | number | 必须 | |||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"page_no": 3,
"page_total": 8,
"result": [
{
"computer_cate_no": "00a13ef46ed4e2def4b647ad5717ca95",
"name": "济南1",
"create_time": "2021-12-08 11:06:44",
"update_time": "2021-12-30 10:28:43"
}
],
"total": 8
},
"msg": "获取成功"
}
# 流路授权
# 生成并获取访问地址
# 基本信息
Path: /open/v1/streamer/get_streamer_addr
Method: POST
接口描述: (需启动流路后调用,流路关闭状态下不可用)
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
streamer_no | text | 是 | ||
type | text | 否 | 1 | 返回token类型说明 0 主控允许旁观 1 主控不允许旁观2 仅允许旁观 不填默认 0 |
minute | text | 否 | 1440 | 有效时长(分钟) 不填默认24小时 |
is_delay | text | 否 | 1 | 获取访问地址时是否强制重置为最新设置的有效期 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
├─ addr_no | number | 必须 | 流路访问地址id | ||
├─ client_url | string | 必须 | 客户端访问链接 | ||
├─ create_time | string | 必须 | 创建时间 | ||
├─ minute | number | 必须 | 有效分钟数 | ||
├─ token | string | 必须 | token | ||
├─ type | number | 必须 | token类型 0 主控允许旁观 1 主控不允许旁观2 仅允许旁观 不填默认 0 | ||
├─ web_url | string | 必须 | 网页端访问地址 | ||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"addr_no": "48f1c4223c164b31b9551f5e811774ff",
"client_url": "dlca://10.0.0.135:10717?token=od78tsc0ufgt46cqsgremw2ulczrwb3f",
"create_time": "2022-01-08T10:01:56+08:00",
"minute": 30,
"token": "od78tsc0ufgt46cqsgremw2ulczrwb3f",
"type": 2,
"web_url": "http://10.0.0.135:9000/app?token=od78tsc0ufgt46cqsgremw2ulczrwb3f&sk=8efa6b9bdcf53503425063c6b39d8f39"
},
"msg": "获取流路访问地址成功"
}
# 访问地址使用详情
# 基本信息
Path: /open/v1/streamer/get_streamer_addr_used_detail
Method: GET
接口描述:
# 请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
addr_no | 是 | 流路授权地址id |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
├─ result | object [] | 必须 | item 类型: object | ||
├─ client_ip | string | 必须 | 客户端ip | ||
├─ token | string | 必须 | token | ||
├─ create_time | number | 必须 | 创建时间 | ||
├─ conn_time | number | 必须 | 连接时间 | ||
├─ default_period | number | 必须 | 默认有效期(分钟) | ||
├─ offline_time | number | 必须 | 实际下线时间 | ||
├─ expire_time | number | 必须 | 实际过期时间 | ||
├─ status | number | 必须 | token状态 0未分配1在线2已下线 | ||
├─ total | number | 必须 | |||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"result": [
{
"client_ip": "",
"token": "od78tsc0ufgt46cqsgremw2ulczrwb3f",
"create_time": 1641607316,
"conn_time": 1641607394,
"default_period": 20,
"offline_time": 1641608596,
"expire_time": 1641609194,
"status": 2
}
],
"total": 3
},
"msg": "获取成功"
}
# 重置访问地址授权时间
<a id=重置访问地址 (需启动流路后使用)155>
# 基本信息
Path: /open/v1/streamer/reset_streamer_addr
Method: POST
**接口描述:**重置访问地址授权时间 ,需启动流路后调用,流路关闭状态下不可用
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
addr_no | text | 是 | 流路访问地址id | |
minute | text | 否 | 1440 | 重置为新的有效时间(分钟数) |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
├─ client_url | string | 必须 | 客户端访问地址 | ||
├─ web_url | string | 必须 | 网页端访问地址l | ||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"client_url": "dlca://10.0.0.135:10716?token=1fe2wnkq62w8p7erolxhns3p0a4j9878",
"web_url": "http://10.0.0.135:9000/app?token=1fe2wnkq62w8p7erolxhns3p0a4j9878&sk=ea9acf6971183c28da8d4f0f1966c8bb"
},
"msg": "临时链接生成成功"
}
# 资源调度
# 启动空闲流路
# 基本信息
Path: /open/v1/apply/idle_unstart_streamer
Method: POST
接口描述:
查找一台空闲的流路,并绑定到指定的应用,并启动该流路,注册token,返回该流路的访问地址,针对需要实时分配和关闭的需求
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
app_code | text | 是 | 要启动的应用唯一码 | |
minute | text | 否 | 生成的访问地址的有效期(分钟) | |
type | text | 否 | 生成的访问地址的类型 1token验证,2,临时密码,3短信验证 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
├─ url | string | 必须 | |||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"url": "http://10.0.0.172:9000/app?token=xxxx9hh4xqusvvphtmidyifgygf5gvrh&sk=xxxxac3d9064d61874eb8c3a44b1d9e5"
},
"msg": "启动流路成功"
}
# 获取预启动空闲流路
# 基本信息
Path: /open/v1/apply/idle_prestart_streamer
Method: POST
接口描述:
查找一台空闲的流路,并绑定到指定的应用,优先返回在线但是没有人连接的流路
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
app_code | text | 是 | 要启动的应用唯一码 | |
is_force_idle | text | 否 | 1 | 是否强制只返回空闲流路 1 强制 |
type | text | 否 | 1 | 生成的访问地址的类型 1 token验证,2,临时密码,3短信验证 |
minute | text | 否 | 1440 | 生成的访问地址的有效期(分钟) |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
├─ url | string | 必须 | 访问地址 | ||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"url": "http://10.0.0.172:9000/app?token=xxxxxtontm1m5yehzkekgyo0p1et40vh&sk=xxxx4ec50a35308ecc882a745a967841"
},
"msg": "获取流路成功"
}
# 服务器管理
# 添加服务器
# 基本信息
Path: /open/v1/computer/add
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 | ||
Body |
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
name | text | 是 | 服务器名称 | |
ip | text | 是 | 服务器ip | |
ip_local | text | 否 | 服务器辅助(升级用,内网模式可省略) | |
computer_cate_no | text | 否 | 服务器分组id | |
web_cloud_port | text | 否 | 9000 | web服务端口,默认9000 |
guard_port | text | 否 | 调度服务端口,默认8050 | |
client_port_start | text | 否 | 串流起始端口号,每一路串流从这个端口号递增 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | 数据 | ||
├─ computer_no | number | 必须 | 服务器id | ||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"computer_no": "xxxxf775f6724645b8e3d063c50cb787"
},
"msg": "添加成功"
}
# 修改服务器
# 基本信息
Path: /open/v1/computer/edit
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
computer_cate_no | text | 是 | 要修改的服务器id | |
name | text | 否 | 服务器名称 | |
ip | text | 否 | 服务器ip | |
rdp_port | text | 否 | 3389 | 服务器rdp端口号 |
guard_port | text | 否 | 调度服务端口,默认8050 | |
computer_cate_no | text | 否 | 服务器分组id | |
web_cloud_port | text | 否 | web服务端口,默认9000 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {},
"msg": "修改成功"
}
# 删除服务器
# 基本信息
Path: /open/v1/computer/del
Method: POST
接口描述:
# 请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
computer_no | text | 是 | 要删除的服务器id |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | 数据 | ||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {},
"msg": "数据成功"
}
# 获取服务器列表
# 基本信息
Path: /open/v1/computer/index
Method: GET
接口描述:
# 请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
page | 否 | 1 | 当前请求的页码 |
limit | 否 | 10 | 每页返回数据条数,默认10条 |
name | 否 | 华北 | 按名称筛选 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 状态码,200代表成功,非200代表失败 | ||
data | object | 必须 | |||
├─ page_no | number | 必须 | |||
├─ page_total | number | 必须 | |||
├─ result | object [] | 必须 | item 类型: object | ||
├─ computer_no | string | 必须 | 服务器id | ||
├─ name | string | 必须 | 服务器名称 | ||
├─ ip | string | 必须 | 服务器ip | ||
├─ rdp_port | number | 必须 | rdp端口号 | ||
├─ computer_cate_no | string | 必须 | 分组id | ||
├─ nature | number | 必须 | 分类 1虚拟机2物理机3入口服务器 | ||
├─ info | string | 必须 | 备注 | ||
├─ guard_port | number | 必须 | 调度服务端口,默认8050 | ||
├─ create_time | string | 必须 | 创建时间 | ||
├─ update_time | string | 必须 | 更新时间 | ||
├─ cpu_percent | number | 必须 | cpu使用情况 | ||
├─ mem_percent | number | 必须 | 内存使用情况 | ||
├─ disk_percent | string | 必须 | 磁盘使用情况 | ||
├─ ip_local | string | 必须 | 服务器辅助ip(升级用,内网模式可省略) | ||
├─ web_cloud_port | number | 必须 | web服务端口,默认9000 | ||
├─ cate_name | string | 必须 | 分组名 | ||
├─ total | number | 必须 | |||
msg | string | 必须 | 状态信息 |
# 返回示例
{
"code": 200,
"data": {
"page_no": 1,
"page_total": 2,
"result": [
{
"computer_no": "5ad77fe1975498ef9a980ba0ac591fcf",
"name": "172外网",
"ip": "10.0.0.172",
"rdp_port": 3389,
"nature": 1,
"info": "",
"guard_port": 8050,
"create_time": "2021-11-09 15:31:39",
"update_time": "2021-11-11 14:16:32",
"cpu_percent": 30.08,
"mem_percent": 16,
"disk_percent": "[\"39.78\",\"76.25\",\"77.81\",\"13.38\",\"17.22\",\"81.17\"]",
"ip_local": "",
"web_cloud_port": 9000,
"computer_cate_no": "604de11fba1c18e719fcad3043e8debd",
"cate_name": "济南区"
}
],
"total": 2
},
"msg": "获取成功"
}
← 接口使用指南