查询网络控制策略v3
更新时间 2026-11-09 14:59:26
最近更新时间: 2026-11-09 14:59:26
接口功能介绍
查询指定基础策略的网络访问、互访及协议通道带宽控制配置。
接口约束
无
URI
GET /v3/strategy/networkControl/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。 | ||
| cloudDesktopInternetAccessEnable | Boolean | 是否允许该策略下的云电脑访问互联网。 | ||
| desktopNetworkInterworkingEnable | Boolean | 是否允许同一策略下的云电脑之间互访。 | ||
| clientInternetConnectivity | String | 客户端访问互联网策略。取值： - ALLOW：允许。 - DENY：禁止。 - INHERIT：继承上级配置。 | ||
| clientCloudLineConnectivity | String | 客户端访问云专线策略。取值： - ALLOW：允许。 - DENY：禁止。 - INHERIT：继承上级配置。 | ||
| bandwidthControl | Object | 协议通道带宽控制配置；关闭时各带宽字段为null。 | bandwidthControl |
表 bandwidthControl
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| enable | Boolean | 是否启用带宽控制。 关闭时带宽字段均为null。 启用时带宽字段均非null。 | ||
| usbBandwidthKB | Integer | USB重定向双向带宽上限。 入、出方向使用同一值。 单位KB/s。 带宽控制关闭时为null。 | ||
| cameraBandwidthKB | Integer | 摄像头重定向带宽上限。 单位KB/s。 带宽控制关闭时为null。 | ||
| fileDragBandwidthKB | Integer | 文件拖拽双向带宽上限。 拖入、拖出使用同一值。 单位KB/s。 带宽控制关闭时为null。 | ||
| fileRedirectionBandwidthKB | Integer | 文件重定向双向带宽上限。 入、出方向使用同一值。 单位KB/s。 带宽控制关闭时为null。 | ||
| printerBandwidthKB | Integer | 打印机重定向带宽上限。 单位KB/s。 带宽控制关闭时为null。 | ||
| networkRedirectionBandwidthKB | Integer | 网络重定向双向带宽上限。 端侧、云侧和入、出方向 使用同一值。 单位KB/s。 带宽控制关闭时为null。 |
枚举参数
无
请求示例
请求url
https://{host}?regionId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&strategyOid=dsy-xxxxxx
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"strategyOid":"dsy-xxxxxx",
"cloudDesktopInternetAccessEnable":true,
"desktopNetworkInterworkingEnable":false,
"clientInternetConnectivity":"ALLOW",
"clientCloudLineConnectivity":"INHERIT",
"bandwidthControl":{
"enable":true,
"usbBandwidthKB":2000,
"cameraBandwidthKB":3000,
"fileDragBandwidthKB":2000,
"fileRedirectionBandwidthKB":2000,
"printerBandwidthKB":1500,
"networkRedirectionBandwidthKB":3000
}
}
}
状态码
请参考 状态码
错误码
请参考 错误码
