查询终端设备策略v3
更新时间 2026-11-09 15:03:35
最近更新时间: 2026-11-09 15:03:35
接口功能介绍
查询指定基础策略的终端重连、自动关机、自动断开和关机重启动作。
接口约束
无
URI
GET /v3/strategy/terminalDevice/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。 | ||
| autoReconnectIntervalSeconds | Integer | 客户端断线后自动重连的尝试间隔，单位秒。 | ||
| autoReconnectTotalSeconds | Integer | 客户端断线后持续尝试自动重连的最长总时长，单位秒。 | ||
| endpointAutoShutdown | Object | 终端在无用户操作时自动关机的配置。 | endpointAutoShutdown | |
| autoDisconnectAfterInactivity | Integer | 客户端自动断开等待时长。 单位分钟。 0表示不自动断开。 | ||
| forbiddenDeviceTypes | Array of Integers | 禁用的终端设备类型编码集合。 取值： - 10：瘦终端ARM。 - 11：瘦终端x86（Ubuntu）。 - 15：IPTV。 - 16：Android瘦终端。 - 20：Android Phone。 - 25：Windows客户端。 - 30：iPhone。 - 35：Android Pad。 - 40：iPad。 - 45：MAC客户端。 | ||
| clientShutdownAction | String | 客户端关机的联动动作。取值： - DEFAULT：默认。 - CLOUD_DESKTOP_ONLY： 仅云电脑关机。 - TERMINAL_ONLY：仅终端关机。 - BOTH：云电脑与终端一起关机。 EXIT_CLOUD_DESKTOP_ONLY： 仅退出云电脑至桌面列表。 | ||
| clientRebootAction | String | 客户端重启的联动动作。取值： - DEFAULT：默认。 - CLOUD_DESKTOP_ONLY： 仅云电脑重启。 - TERMINAL_ONLY：仅终端重启。 - BOTH：云电脑与终端一起重启。 |
表 endpointAutoShutdown
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| mode | String | 终端自动关机模式。取值： - NEVER：不自动关机。 - AFTER_INACTIVITY： 无操作达到指定时长后关机。 | ||
| inactivityMinutes | Integer | 终端无操作时长，单位分钟。 仅AFTER_INACTIVITY模式返回。 其他模式为null。 |
枚举参数
无
请求示例
请求url
https://{host}?regionId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&strategyOid=dsy-xxxxxx
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"strategyOid":"dsy-xxxxxx",
"autoReconnectIntervalSeconds":10,
"autoReconnectTotalSeconds":300,
"endpointAutoShutdown":{
"mode":"AFTER_INACTIVITY",
"inactivityMinutes":60
},
"autoDisconnectAfterInactivity":30,
"forbiddenDeviceTypes":[10,20],
"clientShutdownAction":"CLOUD_DESKTOP_ONLY",
"clientRebootAction":"BOTH"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
