查询Windows更新策略v3
更新时间 2026-11-09 15:07:04
最近更新时间: 2026-11-09 15:07:04
接口功能介绍
查询Windows更新模式；CUSTOM_WSUS模式返回更新服务、安装计划和高级选项。
接口约束
无
URI
GET /v3/strategy/windowsUpdate/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 | Windows更新策略详情。 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| strategyOid | String | 策略Oid。 | ||
| windowsUpdatePolicy | Object | Windows更新策略配置。 | windowsUpdatePolicy |
表 windowsUpdatePolicy
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| mode | String | Windows更新模式。取值： - DISABLED：禁止更新。 - AUTOMATIC：自动更新。 - CUSTOM_WSUS：自定义WSUS。 | ||
| customWsus | Object | 自定义WSUS配置。 仅CUSTOM_WSUS模式返回。 其他模式为null。 | customWsus |
表 customWsus
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | WSUS服务器名称。 | ||
| description | String | WSUS服务器描述。 | ||
| updateService | Object | Intranet Microsoft更新服务配置。 | updateService | |
| automaticUpdates | String | 自动更新状态。取值： - INHERIT：继承（未配置）。 - ENABLED：启用。 - DISABLED：禁用。 | ||
| updateMode | String | 自动更新方式。取值： - NOTIFY_DOWNLOAD_AND_AUTO_INSTALL： 通知下载并自动安装。 - AUTO_DOWNLOAD_NOTIFY_INSTALL： 自动下载并通知安装。 - AUTO_DOWNLOAD_SCHEDULE_INSTALL： 自动下载并计划安装。 - LOCAL_ADMIN_SELECT_SETTING： 由本地管理员选择设置。 - AUTO_DOWNLOAD_NOTIFY_INSTALL_AND_RESTART： 自动下载、通知安装和重启。 | ||
| installDay | String | 计划安装日。取值： - EVERY_DAY：每天。 - SUNDAY：星期日。 - MONDAY：星期一。 - TUESDAY：星期二。 - WEDNESDAY：星期三。 - THURSDAY：星期四。 - FRIDAY：星期五。 - SATURDAY：星期六。 | ||
| installTime | Object | 计划安装时间。 | installTime | |
| automaticMaintenanceEnable | Boolean | 是否在自动维护期间执行计划安装。 | ||
| detectionFrequency | Object | 自动更新检测频率配置。 | detectionFrequency | |
| targetGroup | Object | 客户端目标组配置。 | targetGroup | |
| autoInstallMinorUpdates | String | 是否立即安装次要更新。 取值： - INHERIT：继承（未配置）。 - ENABLED：启用。 - DISABLED：禁用。 | ||
| elevateNonAdmins | String | 是否允许非管理员接受更新通知。 取值： - INHERIT：继承（未配置）。 - ENABLED：启用。 - DISABLED：禁用。 | ||
| noAutoRebootWithLoggedOnUsers | String | 有用户登录时， 更新安装后是否不自动重启。 取值： - INHERIT：继承（未配置）。 - ENABLED：启用。 - DISABLED：禁用。 |
表 updateService
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| useWuServer | String | Intranet Microsoft更新服务 位置状态。取值： - INHERIT：继承（未配置）。 - ENABLED：启用。 - DISABLED：禁用。 | ||
| updateServerUrl | String | Intranet Microsoft 更新服务地址。 无配置时为null。 | ||
| statisticsServerUrl | String | Intranet Microsoft 统计服务器地址。 无配置时为null。 | ||
| alternateDownloadServerUrl | String | 备用内容下载服务器地址。 无配置时为null。 | ||
| fillEmptyContentUrlsEnable | Boolean | 下载URL为空时是否允许从备用下载服务器下载内容。 |
表 installTime
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| mode | String | 安装时间模式。取值： - AUTO：自动安排。 - FIXED_HOUR：固定小时。 | ||
| hour | Integer | 固定安装小时。 仅FIXED_HOUR模式返回。 其他模式为null。 |
表 detectionFrequency
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| state | String | 自定义更新检测频率状态。 取值： - INHERIT：继承（未配置）。 - ENABLED：启用。 - DISABLED：禁用。 | ||
| hours | Integer | 检测间隔，单位小时。 仅ENABLED状态返回。 其他状态为null。 |
表 targetGroup
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| state | String | 客户端目标组状态。取值： - INHERIT：继承（未配置）。 - ENABLED：启用。 - DISABLED：禁用。 | ||
| name | String | 客户端目标组名称。 仅ENABLED状态返回。 其他状态为null。 |
枚举参数
无
请求示例
请求url
https://{host}?regionId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&strategyOid=dsy-xxxxxx
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"strategyOid":"dsy-xxxxxx",
"windowsUpdatePolicy":{
"mode":"CUSTOM_WSUS",
"customWsus":{
"name":"企业WSUS策略",
"description":"办公网终端更新策略",
"updateService":{
"useWuServer":"ENABLED",
"updateServerUrl":"https://wsus.example.com/update",
"statisticsServerUrl":"https://wsus.example.com/statistics",
"alternateDownloadServerUrl":"https://download.example.com/windows",
"fillEmptyContentUrlsEnable":true
},
"automaticUpdates":"ENABLED",
"updateMode":"AUTO_DOWNLOAD_SCHEDULE_INSTALL",
"installDay":"MONDAY",
"installTime":{
"mode":"FIXED_HOUR",
"hour":2
},
"automaticMaintenanceEnable":true,
"detectionFrequency":{
"state":"ENABLED",
"hours":6
},
"targetGroup":{
"state":"ENABLED",
"name":"OFFICE-DESKTOPS"
},
"autoInstallMinorUpdates":"ENABLED",
"elevateNonAdmins":"DISABLED",
"noAutoRebootWithLoggedOnUsers":"ENABLED"
}
}
}
}
状态码
请参考 状态码
错误码
请参考 错误码
