查询桌面工具栏策略v3
更新时间 2026-11-09 14:55:49
最近更新时间: 2026-11-09 14:55:49
接口功能介绍
查询大屏客户端和移动客户端桌面工具栏各入口的显示状态。
接口约束
无
URI
GET /v3/strategy/desktopToolbar/describe
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| strategyOid | 是 | String | 策略Oid。 | dsy-xxxxxx |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码，800表示请求成功，900表示请求失败。 | 800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 桌面工具栏策略详情。 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| strategyOid | String | 策略Oid。 | ||
| desktopToolbar | Object | 桌面工具栏配置。 | desktopToolbar |
表 desktopToolbar
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| bigScreen | Object | 大屏客户端工具栏配置。 | bigScreen | |
| mobile | Object | 移动客户端工具栏配置。 | mobile |
表 bigScreen
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| deskMin | Boolean | 是否显示窗口最小化按钮。 | ||
| deskWin | Boolean | 是否显示桌面窗口化按钮。 | ||
| bigScreenExit | Object | 大屏客户端退出区配置。 | bigScreenExit | |
| bigScreenTools | Object | 大屏客户端工具区配置。 | bigScreenTools |
表 bigScreenExit
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| enable | Boolean | 是否显示退出区。 | ||
| exit | Boolean | 是否显示退出云电脑按钮。 | ||
| lock | Boolean | 是否显示云电脑锁屏按钮。 | ||
| restart | Boolean | 是否显示重启云电脑按钮。 | ||
| shutdown | Boolean | 是否显示关闭云电脑按钮。 |
表 bigScreenTools
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| enable | Boolean | 是否显示工具区。 | ||
| oneKeyOptimization | Boolean | 是否显示一键优化入口。 | ||
| network | Boolean | 是否显示网络状态入口。 | ||
| report | Boolean | 是否显示报障入口。 | ||
| safeCenter | Boolean | 是否显示安全中心入口。 | ||
| screenSharing | Boolean | 是否显示屏幕共享入口。 | ||
| operationAudit | Boolean | 是否显示自助服务入口。 | ||
| liveZoneMgr | Boolean | 是否显示直播专区入口。 | ||
| desktopManager | Object | 偏好设置入口配置。 | desktopManager |
表 desktopManager
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| enable | Boolean | 是否显示偏好设置入口。 | ||
| usbConfig | Boolean | 是否显示USB管理入口。 | ||
| desktopInfo | Boolean | 是否显示桌面信息入口。 | ||
| otherConfig | Boolean | 是否显示其他设置入口。 | ||
| picConfig | Boolean | 是否显示画面设置入口。 | ||
| showConfig | Boolean | 是否显示显示配置入口。 | ||
| systemReset | Boolean | 是否显示系统还原入口。 | ||
| usbDeviceConfig | Boolean | 是否显示设备调试入口。 |
表 mobile
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| mobileExit | Object | 移动客户端退出区配置。 | mobileExit | |
| mobileTools | Object | 移动客户端工具区配置。 | mobileTools |
表 mobileExit
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| enable | Boolean | 是否显示退出区。 | ||
| exit | Boolean | 是否显示退出云电脑按钮。 | ||
| restart | Boolean | 是否显示重启云电脑按钮。 | ||
| shutdown | Boolean | 是否显示关闭云电脑按钮。 |
表 mobileTools
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| enable | Boolean | 是否显示工具区。 | ||
| showConfig | Boolean | 是否显示显示配置入口。 | ||
| network | Boolean | 是否显示网络状态入口。 | ||
| report | Boolean | 是否显示报障入口。 | ||
| safeCenter | Boolean | 是否显示安全中心入口。 | ||
| systemRecovery | Boolean | 是否显示系统恢复入口。 | ||
| screenSharing | Boolean | 是否显示屏幕共享入口。 | ||
| operationAudit | Boolean | 是否显示自助服务入口。 | ||
| liveZoneMgr | Boolean | 是否显示直播专区入口。 |
枚举参数
无
请求示例
请求url
https://{host}?regionId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&strategyOid=dsy-xxxxxx
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"strategyOid":"dsy-xxxxxx",
"desktopToolbar":{
"bigScreen":{
"deskMin":true,
"deskWin":true,
"bigScreenExit":{
"enable":true,
"exit":true,
"lock":true,
"restart":true,
"shutdown":false
},
"bigScreenTools":{
"enable":true,
"oneKeyOptimization":true,
"network":true,
"report":true,
"safeCenter":true,
"screenSharing":false,
"operationAudit":true,
"liveZoneMgr":false,
"desktopManager":{
"enable":true,
"usbConfig":true,
"desktopInfo":true,
"otherConfig":true,
"picConfig":true,
"showConfig":true,
"systemReset":false,
"usbDeviceConfig":true
}
}
},
"mobile":{
"mobileExit":{
"enable":true,
"exit":true,
"restart":true,
"shutdown":false
},
"mobileTools":{
"enable":true,
"showConfig":true,
"network":true,
"report":true,
"safeCenter":true,
"systemRecovery":true,
"screenSharing":false,
"operationAudit":true,
"liveZoneMgr":false
}
}
}
}
}
状态码
请参考 状态码
错误码
请参考 错误码
